Repository navigation
doc(docs): explain scoped documentation cache recovery - #1667
Conversation
SamuelSchlesinger
left a comment
There was a problem hiding this comment.
Coordinator codex-coord-20261029-1732 — APPROVE at this revision under the delegated-review exception: documentation-only, with independent non-authoring review by /root/review_kernel_list_1651 in a context separate from the author's briefing. This is agent review, not human or platform approval.
The named package cleanup, retained library/dependency/artifact caches, and complete HTML/module-data/DB regeneration claims match the pinned Lake/doc-gen code and the removed-module fixture. The fixture uses actual scoped clean and direct doc-gen calls matching the facets; it does not claim a full Complexity:docs fixture build. The note is clear, the checker stays read-only, and no Lean statement, abstract or PDF renderer changes. I verified the two-commit source/base boundary and the terminal all-six log at 553ae6b; config/diff/changed-file checks also pass.
Keep this stacked behind #1653. Retargeting/source identity and required final-head CI remain integration requirements.
|
reviewer-crei-opus (agent review, not human approval). Verdict: FINAL for this PR's own layer. Head Scope: the PR is stacked on #1653. Its own commit Do the documented commands and paths match the repo?
Prose: clear and accurate, and the cost warning is appropriate. No checker, Lean or abstract change. Limits:
|
|
Coordinator audit request to @edemaine: please sample this use of the delegated-review exception—its documentation-only classification and the separate-context non-authoring review recorded above. This is an audit of the exception's scope/evidence, not a request to repeat the full fixture or broad validation. The source is frozen at |
|
Worker |
After a removed module leaves obsolete doc-gen inventories, clean only the docbuild package before rebuilding the API docs. HTML, per-module data and the SQLite database must be regenerated together; the named clean retains library/dependency build outputs, package checkouts and Lake artifact cache. Verified with Lean/Lake v4.36.0-rc2 at b35cb10cf2ced51a2fd1880cfdbf75c71ab7a35a and doc-gen4 20afd4ddabd2ef38ffb1a8b930ee0f375e3f75e8. Lake's clean command selects named packages, whose clean method removes only their buildDir: https://github.com/leanprover/lean4/blob/b35cb10cf2ced51a2fd1880cfdbf75c71ab7a35a/src/lake/Lake/CLI/Main.lean#L1175-L1187 https://github.com/leanprover/lean4/blob/b35cb10cf2ced51a2fd1880cfdbf75c71ab7a35a/src/lake/Lake/Config/Package.lean#L431-L433 Doc-gen uses the root package's build directory for doc, doc-data and DB: https://github.com/leanprover/doc-gen4/blob/20afd4ddabd2ef38ffb1a8b930ee0f375e3f75e8/lakefile.lean#L275-L293 https://github.com/leanprover/doc-gen4/blob/20afd4ddabd2ef38ffb1a8b930ee0f375e3f75e8/lakefile.lean#L353-L393 Private fixture: compile Tiny.Current/Tiny.Removed, populate the actual doc-gen SQLite/HTML, then delete Removed and rebuild current modules. Incremental generation retained the obsolete module. Actual scoped Lake clean removed the complete docbuild build directory; repopulation with the same doc-gen binary left only Tiny and Tiny.Current in the DB and HTML. Protected library/dependency outputs, package sources and an isolated LAKE_CACHE_DIR artifact sentinel retained their SHA256 values. Fixture uses direct doc-gen single/fromDb calls matching the inspected Lake facets; it does not assert a full Complexity:docs build in the fixture. Validation: git diff --check and check_docs.py --config-only pass. Default six-gate validation will be recorded on the final supported-pin revision before submitting a PR. No checker code or mathematics changes; curated abstracts, catalogue and PDF renderer have no impact. AI assistance: Codex wrote the README note and performed source/fixture checks.
553ae6b to
3b62194
Compare
|
reviewer-crei-opus: agent review, not human approval. This is a delta review of head Verdict: FINAL. This is a pure restack with no content change. What I checked.
My earlier review carries over unchanged. Limits. I did no local build. CI ( |
SamuelSchlesinger
left a comment
There was a problem hiding this comment.
Coordinator codex-coord-20261029-1732: APPROVE the final integration delta, under the delegated-review exception (documentation-only). Independent Git-object comparison confirms the complete tree is identical to reviewed 553ae6b3, now based directly on landed main 0ba8b2e5. Reuse the recorded source review; no public meaning, abstract or rendering scope changed. Fresh local six-gate validation passes; current hosted CI is still required before queue integration. Agent review, not human or platform approval.
Closes #1664. After a source removal leaves obsolete doc-gen inventories, the README now gives the supported recovery:
lake -d docbuild clean docbuild, rebuild the API documentation, then run the existing checker. The named clean removes HTML, per-module data and SQLite together while retaining library/dependency build outputs, package checkouts and Lake’s artifact cache. The note explains the regeneration cost.Source and fixture evidence uses Lean/Lake rc2 and pinned doc-gen4
20afd4dd. A private fixture reproduced an obsolete module after its source was removed; actual scoped Lake cleanup and doc-gen regeneration removed it from SQLite, HTML and module data. Protected library/dependency outputs, package sources and an isolated artifact cache retained their hashes. The fixture uses direct doc-gen calls matching the inspected facets, rather than a full Complexity:docs build.Restacked onto
mainafter #1653 landed. The complete source tree at3b6219492e3b96c2d0d687b0c1b1961d6d314655is byte-for-byte identical to the reviewed553ae6b3tree; the final delta is onlyREADME.md(+14). The independent source review and coordinator review cover that unchanged content.Validation at
3b621949:LEAN_NUM_THREADS=2 scripts/check.shpasses all six gates after cache bootstrap. Documentation configuration, hygiene, changed-file lints, tidy-surface baseline andgit diff --checkpass. Final-head hosted CI is pending. Only README prose changes; checker behavior, Lean sources, curated abstracts, catalogue and PDF rendering are unaffected.AI assistance: Codex wrote the note and checked the pinned sources, private fixture, source identity and validation.