docs: VitePress code annotations + one mis-rendered list (Phase J) - #922
Open
ocots wants to merge 1 commit into
Open
docs: VitePress code annotations + one mis-rendered list (Phase J)#922ocots wants to merge 1 commit into
ocots wants to merge 1 commit into
Conversation
…hase J) migration.md — the site's only page with genuine before/after pairs: - three `# before` / `# after` block pairs collapsed into one block each, using `# [!code --]` / `# [!code ++]` (green/red diff gutter) - the `OpenLoop` construction trap marked `# [!code error]` - the 4-positional silent-misread call marked `# [!code warning]` (both inside `!!! warning` admonitions — verified to render there) flows/overview.md — the "Three things this section does" ordered list became an unordered list: DocumenterVitepress mis-numbers any ordered list whose items carry block content (LuxDL/DocumenterVitepress.jl#150), and these three are a set, not a sequence. The `api/*` ordered lists have the same bug but live in CTBase/CTSolvers docstrings — cross-repo, out of scope here. Verified: full docs build exit 0, 0 unresolved @ref; `has-diff` / `has-error` / `has-warning` classes present in migration.html, no `<ol>` in flows/overview.html. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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
1 participant
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.
What
Phase J: use the VitePress code-block features DocumenterVitepress exposes but the site never used (
grep -r '\[!code' docs/src→ 0). Plus the one source-level ordered list the DocumenterVitepress#150 mis-numbering bug hits.J turned out small. The only page with genuine before/after pairs is
migration.md. Nothing else in the current docs has a before/after pair, a "one line that matters" long snippet, or two genuine alternatives side by side. Full classification in.reports/campaign/J-code-presentation.md.Changes
migration.md# before/# afterblock pairs → one block each with# [!code --]/# [!code ++](red/green diff gutter). Inline explanatory comments (# 3 positional/# paired keywords) kept — the[!code …]token is stripped from the rendered comment.OpenLoopconstruction trap →# [!code error]# [!code warning][!code]-in-admonition, verified to render (has-error/has-warningin the built HTML)flows/overview.mdNot touched: the
api/*ordered lists (same bug, but sourced from CTBase/CTSolvers docstrings — cross-repo); executed@exampleblocks (annotations don't work there);abstract-syntax.md's:( … )grammar patterns (E1's deliberate choice);gpu.md(#885).Companion
A
Handbook/VITEPRESS-DOC.md"Presenting code" section (the feature table, the static-fences-only constraint, a before/after example, the "no code-group for a correspondence pair" rule) goes as a separate Handbook PR.Verification
Full
julia --project=. docs/make.jl: exit 0, 0Cannot resolve @ref.migration.htmlhas 10line diffspans (5+5), 1has-error, 1has-warning;flows/overview.htmlhas no<ol>. Only build errors are the 4 unchanged Phase-D@extrefitems.Add the
run documentationlabel to build the site in CI.🤖 Generated with Claude Code