itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-09-25 11:14:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

update contributing to show how to build the docs

Browse Source 
The contributing guide referenced a script that was deleted in
1271bb4de0c0 so it wasn't possible to follow the contributing guide
successfully prior to contributing doc improvements.
This commit is contained in:
Doug Goldstein 2018-02-17 22:41:32 -06:00
parent 489f570d47
commit e59171aab0
No known key found for this signature in database
GPG Key ID: C88CD4C6DF24365D
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
CONTRIBUTING.md
View File

@ -109,13 +109,16 @@ and [merges][mergequeue] it into Cargo's `master` branch.
To contribute to the documentation, all you need to do is change the markdown
files in the `src/doc` directory. To view the rendered version of changes you
have made locally, run:
have made locally, make sure you have `mdbook` installed and run:
```sh
sh src/ci/dox.sh
open target/doc/index.html
cd src/doc
mdbook build
open book/index.html
```
To install `mdbook` run `cargo install mdbook`.
## Issue Triage