Skip to content

Commit

Permalink
docs: ask MkDocs to fail on links to non-existent sections
Browse files Browse the repository at this point in the history
This also requires anchors to be lower-cased: mkdocs/mkdocs#3703
  • Loading branch information
ilyagr committed May 13, 2024
1 parent dfbb36a commit 00c45cb
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/design/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Initial Version, 10.12.2022 (view full history [here](https://docs.google.com/do
Jujutsu which will be used to seamlessly integrate with build systems, linters
and formatters. This is achieved by running a user-provided command or script
across multiple revisions. For more details, read the
[Use-Cases of jj run](#Use-Cases-of-jj-run).
[Use-Cases of jj run](#use-cases-of-jj-run).

## Preface

Expand Down Expand Up @@ -229,7 +229,7 @@ command)
(may alias another command)
* --clean, remove existing workspaces and remove the ignored files
* --readonly, ignore changes across multiple run invocations
* --error-strategy=`continue|stop|fatal`, see [Dealing with failure](#Dealing-with-failure)
* --error-strategy=`continue|stop|fatal`, see [Dealing with failure](#dealing-with-failure)

### Integrating with other commands

Expand Down
2 changes: 1 addition & 1 deletion docs/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ the [tutorial][tut].
[detached]: https://git-scm.com/docs/git-checkout#_detached_head
[gh]: https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent
[http-auth]: https://github.com/martinvonz/jj/issues/469
[tut]: tutorial.md#Conflicts
[tut]: tutorial.md#conflicts
[stacked]: https://jg.gg/2018/09/29/stacked-diffs-versus-pull-requests/

## Using several remotes
Expand Down
2 changes: 1 addition & 1 deletion docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ See [visible commits](#visible-commits).

## Operation

A snapshot of the [visible commits](#visible-commits) and [branches](#branches)
A snapshot of the [visible commits](#visible-commits) and [branches](#branch)
at a given point in time (technically a [view object](#view)), together with
some metadata. The metadata includes the username, hostname, timestamps, and
pointers to the operation's parents.
Expand Down
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ extra:
version:
provider: mike

validation:
anchors: warn

# IMPORTANT: any changes to plugins have to be duplicated in
# `mkdocs-offline.yml`. See that file for more details.
plugins:
Expand Down

0 comments on commit 00c45cb

Please sign in to comment.