Repository navigation
Docs: escape the <user> and <account> placeholders in deployment.md's web UI paths - #625
Merged
Merged
Conversation
Three UI paths in docs/deployment.md wrote their placeholders bare in
bold text: **Admin → Users → <user> → Deactivate**, **Admin → Users →
<user> → Tokens** and **Admin → Service accounts → <account>**.
Markdown reads <user> and <account> as HTML tags, so GitHub's sanitizer
dropped them ("Admin → Users → → Deactivate") and mdBook dropped them
too, warning about an unclosed HTML tag while exiting Strong.
A backslash escapes each one (\<user>, \<account>), which GitHub and
pulldown-cmark both render as the literal text. A code span would not
fit, since the rest of each path is plain bold text. CHANGELOG.md has
the same problem in two 2.0.0 entries but stays as it is: a change never
edits it.
Fixes #624
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012e6DJXh2a4iuE7x7K94GNJ
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #624
Problem
Three web UI paths in
docs/deployment.mdused bare<user>and<account>placeholders inside bold text, outside a code span. Markdown read them as HTML tags, so GitHub's sanitizer dropped them and the page showed "Admin → Users → → Deactivate". mdBook, which builds the docs site in #623, dropped them too and warned about an unclosed HTML tag<user>while exiting Strong.Change
docs/deployment.md: each placeholder is escaped with a backslash (\<user>,\<account>). GitHub and pulldown-cmark both render that as the literal text<user>. A code span would not fit, because the rest of the bold UI path is plain text. The affected lines:docs/changes/2.1.1/624.docs.md: the changelog fragment.CHANGELOG.mdhas the same problem in two 2.0.0 entries (<user>,<name>). It stays unchanged because a change never edits it.Verification
cargo xtask changelog --check: passes.cargo xtask docsonly exists on Docs: publish the guides as a GitHub Pages site with navigation and search, built with mdBook by cargo xtask docs #623's branch, so I applied this change on top of that branch:cargo xtask docs --checkpasses: "12 page(s) of the site, every link resolves."cargo xtask docswith mdBook 0.5.4: the threeunclosed HTML tag … found in deployment.md while exiting Strongwarnings are gone. The two warnings left are forchangelog.md, which this PR deliberately leaves alone. Indeployment.htmlthe paths now readAdmin → Users → <user> → Deactivate,Admin → Users → <user> → TokensandAdmin → Service accounts → <account>.🤖 Generated with Claude Code
https://claude.ai/code/session_012e6DJXh2a4iuE7x7K94GNJ