Skip to content

docs: drop docs/attic, close audit F3 (E6 phase B) - #940

Merged
ocots merged 1 commit into
mainfrom
docs/drop-attic
Sep 2, 2026
Merged

docs: drop docs/attic, close audit F3 (E6 phase B)#940
ocots merged 1 commit into
mainfrom
docs/drop-attic

Conversation

@ocots

@ocots ocots commented Sep 2, 2026

Copy link
Copy Markdown
Member

What

E6 phase B of the documentation campaign — delete docs/attic/ and fold in one small audit finding.

  • Delete docs/attic/ (24 pages, ~9 000 lines). These were pre-v2.1 docs kept only for harvesting into the rewritten site. The attic audit (campaign phase N) walked them file-by-file: coverage by the live site is ~1:1, nothing there is the sole home of important content, and E7 (docs: restore macro-free worked problems on functional-api.md (E7) #938) closed the one content regression it found (F1 — the macro-free worked problems). Nothing in docs/src/ or docs/make.jl references the attic.
  • Audit F3solve/choosing-a-method.md named OptimalControl.get_strategy_registry(), which docs/reports/99-api-coverage.md §12 says must not be documented (it is internal, not re-exported). Rephrased to "internal and not re-exported".
  • Work board — row 13 (docs: drop docs/attic) → 🟡.

Verification

Full local docs build (julia --project=. docs/make.jl): exit 0, VitePress site builds. The only unresolved links are the six pre-existing @extref items (Plots.plot(::CTModels.Solutions.Solution) ×4, CTBase.Strategies.parameter ×2), unchanged from main and in the tolerated warnonly classes. Zero attic-related breakage.

Deferred to a follow-up PR

The cahier §12 acceptance walk (§6 capability inventory × sitemap; §8.2 deprecated-spelling table) and audit F4 (the stale 193 symbol count in 99-api-coverage.md — the current measured count is 203) are a substantive verification pass and get their own PR.

🤖 Generated with Claude Code

@ocots ocots added the run documentation Trigger the Documentation workflow on this PR label Sep 2, 2026
The attic (24 pre-v2.1 pages) was kept only for harvesting by the
rewritten site. The attic audit (campaign phase N) confirmed coverage is
~1:1 and E7 (#938) closed the one content regression it found (F1), so
the directory is now dead weight. Nothing in `docs/src/` or `docs/make.jl`
references it; the full docs build is unchanged (exit 0, only the six
pre-existing @extref items in the tolerated warnonly classes).

Also folds in audit finding F3: `solve/choosing-a-method.md` named
`OptimalControl.get_strategy_registry()`, which `99-api-coverage.md` §12
says must not be documented — rephrased to "internal and not re-exported".

The cahier §12 acceptance walk and F4 (the stale 193 symbol count in
`99-api-coverage.md`) are deferred to a dedicated follow-up PR.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@ocots
ocots merged commit ea0e6f9 into main Sep 2, 2026
6 checks passed
@ocots
ocots deleted the docs/drop-attic branch September 2, 2026 07:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

run documentation Trigger the Documentation workflow on this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant