wez/wezterm
1
1
Fork 0
mirror of https://github.com/wez/wezterm.git synced 2024-11-22 13:16:39 +03:00
Code Issues Projects Releases Wiki Activity

Contribute docs update (#4326)

Browse Source 
* Update CONTRIBUTING.md

* Apply suggestions from code review

Co-authored-by: Wez Furlong <wez@wezfurlong.org>

* Update with new build method.

---------

Co-authored-by: Wez Furlong <wez@wezfurlong.org>
This commit is contained in:
Danielkonge 2023-09-22 02:52:26 +02:00 committed by GitHub
parent 4adbe89cb3
commit 3141131014
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
CONTRIBUTING.md
View File

@ -13,28 +13,18 @@ There's never enough! Pretty much anything is fair game to improve here.
### Running the doc build yourself
To check your documentation additions, you can optionally build the docs yourself and see how the changes will look on the webpage.
To run the doc build yourself:
```console
$ ./ci/build-docs.sh
```
To serve them up and automatically rebuild and refresh the docs in your
browser, run:
To check your documentation additions, you can optionally build the docs yourself and see how the changes will look on the webpage.
To serve them up, and then automatically rebuild and refresh the docs in your browser, run:
```console
$ ci/build-docs.sh serve
```
And then click on the URL that it prints out after it has performed the first build.
and then click on the URL that it prints out after it has performed the first
build.
Any arguments passed to `build-docs.sh` are passed down to the underlying
`mkdocs` utility.
Any arguments passed to `build-docs.sh` are passed down to the underlying `mkdocs` utility.
Look at [mkdocs serve](https://www.mkdocs.org/user-guide/cli/#mkdocs-serve) for more information on additional parameters.
### Operating system specific installation instructions?
There are a lot of targets out there. Today we have docs that are Ubuntu biased
@ -68,14 +58,14 @@ I tend to iterate and sanity check as I develop using `cargo check`; it
will type-check your code without generating code which is much faster
than building everything in release mode:
```
```console
$ cargo check
```
Likewise, if you want to quick check that something works, you can run it
in debug mode using:
```
```console
$ cargo run
```
@ -84,7 +74,7 @@ give you more detail in the backtrace produced if you run `RUST_BACKTRACE=1 carg
If you get a panic and want to examine local variables, you'll need to use gdb:
```
```console
$ cargo build
$ gdb ./target/debug/wezterm
$ break rust_panic # hit tab to complete the name of the panic symbol!
@ -98,7 +88,7 @@ This will help ensure that your contributions keep working as things change.
You can run the existing tests using:
```
```console
$ cargo test --all
```
@ -133,7 +123,7 @@ how that process works.
Make sure that the tests are working and that the code is correctly
formatted otherwise the continuous integration system will fail your build:
```
```console
$ rustup component add rustfmt-preview # you only need to do this once
$ cargo test --all
$ cargo fmt --all