diff --git a/docs/contributing.md b/docs/contributing.md index e9fd1c910..3bc02398d 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -114,7 +114,7 @@ These are listed roughly in order of decreasing importance. The `--workspace` flag is needed to run the tests on all crates; by default, only the crate in the current directory is tested. -2. Github CI checks require that the code is formatted with the *nightly* +2. GitHub CI checks require that the code is formatted with the *nightly* version of `rustfmt`. To do this on your computer, install the nightly toolchain and use `cargo +nightly fmt`. @@ -214,10 +214,10 @@ pure Git repo if you prefer. 2. Make sure `jjfan.github.com/jj` includes the `gh-pages` branch of the jj repo and run `git fetch origin gh-pages`. -3. Go to the Github repository settings, enable Github Pages, and configure them +3. Go to the GitHub repository settings, enable GitHub Pages, and configure them to use the `gh-pages` branch (this is usually the default). -4. Run the same `sh` script that is used in Github CI (details below): +4. Run the same `sh` script that is used in GitHub CI (details below): ```shell .github/scripts/docs-build-deploy 'https://jjfan.github.io/jj/'\ @@ -294,4 +294,4 @@ you can submit a PR based on the `gh-pages` branch of [library docs]: https://docs.rs/prost-build/latest/prost_build/#sourcing-protoc The `.rs` files generated from `.proto` files are included in the repository, - and there is a Github CI check that will complain if they do not match. + and there is a GitHub CI check that will complain if they do not match. diff --git a/docs/github.md b/docs/github.md index 439781070..eebb8700b 100644 --- a/docs/github.md +++ b/docs/github.md @@ -4,7 +4,7 @@ This guide assumes a basic understanding of either Git or Mercurial. ## Set up an SSH key -As of December 2022 it's recommended to set up an SSH key to work with Github +As of December 2022 it's recommended to set up an SSH key to work with GitHub projects. See [GitHub's Tutorial][gh]. This restriction may be lifted in the future, see [issue #469][http-auth] for more information and progress on authenticated http. diff --git a/mkdocs.yml b/mkdocs.yml index fb7252364..1a0abcc31 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -41,7 +41,7 @@ nav: - 'Getting started': - 'Installation and Setup': 'install-and-setup.md' - 'Tutorial and Birds-Eye View': 'tutorial.md' - - 'Working with Github': 'github.md' + - 'Working with GitHub': 'github.md' - FAQ: 'FAQ.md'