docs: convert ordered lists to bullets across src/ and docs/src/ - #548
Merged
Merged
Conversation
DocumenterVitepress mis-renders ordered lists — valid 1./2./3. source comes out as <ol start="3">, the first item absorbed as unstyled prose glued onto whatever paragraph precedes it (LuxDL/DocumenterVitepress.jl#150, open, no fix). Confirmed on this site: docs/build/1/api/{options,qualified}.html both showed it. Empirically, even clean, single-line, correctly-blank-line-separated lists trigger the bug — no source-level tell predicts safety by inspection, so every ordered list found is fixed, not just the ones observed broken today. Two batches: - src/ (7 files, 10 lists): Options/option_definition.jl, Strategies/api/{utilities,configuration,builders,registry}.jl, Strategies/contract/abstract_strategy.jl, Exceptions/Exceptions.jl — these are transcluded into every downstream package's api/* pages via @docs, so this also unblocks the same bug on CTFlows.jl, CTModels.jl, CTSolvers and OptimalControl's own sites once released. - docs/src/ (8 files, 14 lists): getting-started.md and seven guide/*.md pages — hand-written prose, never previously swept (earlier sweeps only checked OptimalControl's own docs/src/, not this repo's). Marker-only change (1. -> -), no prose edits; the one nested-sublist case (none here — CTSolvers' abstract_solver.jl has that one) would keep inner markers untouched, only the outer numbering changes. Verified: full site rebuild, 0 <ol start= anywhere, 0 errors. Companion PRs open in parallel on OptimalControl, CTSolvers, CTModels.jl and CTFlows.jl. Full plan: control-toolbox/OptimalControl.jl .reports/campaign/M-ordered-list-sweep.md Co-Authored-By: Claude Opus 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
DocumenterVitepressmis-renders ordered lists — valid1. 2. 3.comes out as<ol start="3">, the first item absorbed as unstyled prose. LuxDL/DocumenterVitepress.jl#150, open, no fix. Confirmed on this site before this change:docs/build/1/api/options.htmlanddocs/build/1/api/qualified.htmlboth showed it.Empirically, even clean, single-line, correctly-blank-line-separated lists trigger the bug — no source-level tell predicts safety by inspection, so every ordered list found by source grep is fixed here, not just the ones observed broken.
Marker-only change (
1.→-), no prose edits.src/— 7 files, 10 listsOptions/option_definition.jl,Strategies/api/{utilities,configuration,builders,registry}.jl,Strategies/contract/abstract_strategy.jl,Exceptions/Exceptions.jl. These are transcluded into every downstream package'sapi/*pages via@docs, so this also fixes the same bug on CTFlows.jl's, CTModels.jl's, CTSolvers' and OptimalControl's own sites — once this releases and each of those raises its[compat]floor to reach it.docs/src/— 8 files, 14 listsgetting-started.mdand sevenguide/*.mdpages — hand-written prose, never previously swept (earlier ecosystem sweeps only checked OptimalControl's owndocs/src/, not this repo's own pages).Context
Companion PRs open in parallel on OptimalControl, CTSolvers, CTModels.jl and CTFlows.jl — same bug, same fix, coordinated as one cross-repo sweep. Full plan and inventory:
control-toolbox/OptimalControl.jl→.reports/campaign/M-ordered-list-sweep.md.Verified
grep -roE '<ol start="[0-9]+">' docs/build/1/→ empty, site-wide.🤖 Generated with Claude Code