From 00c45cb76b80430c46ea9215a64f1a7a4902ddb6 Mon Sep 17 00:00:00 2001 From: Ilya Grigoriev Date: Mon, 6 May 2024 15:54:55 -0700 Subject: [PATCH] docs: ask MkDocs to fail on links to non-existent sections This also requires anchors to be lower-cased: https://github.com/mkdocs/mkdocs/issues/3703 --- docs/design/run.md | 4 ++-- docs/github.md | 2 +- docs/glossary.md | 2 +- mkdocs.yml | 3 +++ 4 files changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/design/run.md b/docs/design/run.md index 3c7883e089..99228b9ec8 100644 --- a/docs/design/run.md +++ b/docs/design/run.md @@ -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 @@ -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 diff --git a/docs/github.md b/docs/github.md index c5acc8dce4..a15e45e15b 100644 --- a/docs/github.md +++ b/docs/github.md @@ -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 diff --git a/docs/glossary.md b/docs/glossary.md index 81a1f58dfb..a934e7dbb3 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -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. diff --git a/mkdocs.yml b/mkdocs.yml index c8ed47351e..65e50d6cbf 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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: