Skip to content

Commit

Permalink
Format contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jabielecki authored Nov 20, 2024
1 parent b6de988 commit 1b9c9cf
Showing 1 changed file with 22 additions and 24 deletions.
46 changes: 22 additions & 24 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -300,27 +300,27 @@ curl -LsSf https://astral.sh/uv/install.sh | sh
#### Windows
``` { .shell .copy }
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```
``` { .shell .copy }
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```
#### Homebrew

``` { .shell .copy }
brew install uv
```
``` { .shell .copy }
brew install uv
```

#### Cargo

``` { .shell .copy }
# This might take a while
cargo install --git https://github.com/astral-sh/uv uv
```
``` { .shell .copy }
# This might take a while
cargo install --git https://github.com/astral-sh/uv uv
```

#### Other options

* Directly download the binaries from GitHub: [uv releases](https://github.com/astral-sh/uv/releases).
* Even more options: [Installing uv](https://docs.astral.sh/uv/getting-started/installation/).
* Directly download the binaries from GitHub: [uv releases](https://github.com/astral-sh/uv/releases).
* Even more options: [Installing uv](https://docs.astral.sh/uv/getting-started/installation/).

### Build the docs

Expand All @@ -333,21 +333,19 @@ uv run mkdocs serve
Open <http://127.0.0.1:8000> in your browser to see the docs.

As you edit the `.md` files in `docs/`, the website should be rebuilt and
reloaded in your browser automatically.

!!! note "If the docs are not updating"
Check the terminal from which you ran `uv run mkdocs serve` for any build
errors or warnings. Warnings about `"GET /versions.json HTTP/1.1" code 404`
are expected and harmless.
reloaded in your browser automatically. If the docs are not updating, check
the terminal from which you ran `uv run mkdocs serve` for any build errors
or warnings. Warnings about `"GET /versions.json HTTP/1.1" code 404` are
expected and harmless.

## Building the entire website

!!! tip
Building the entire website is not usually necessary. If you are editing
documentation, the previous section is enough.

These instructions are relevant if you are working on the versioning of the
documentation that we currently do with `mike`.
> [!TIP]
> Building the entire website is not usually necessary. If you are editing
> documentation, the previous section is enough.
>
> These instructions are relevant if you are working on the versioning of the
> documentation that we currently do with `mike`.
The full `jj` website includes the documentation for several `jj` versions
(`prerelease`, latest release, and the older releases). The top-level
Expand Down

0 comments on commit 1b9c9cf

Please sign in to comment.