fix: keep documentation identity stable across checkouts - #231
Conversation
|
🦞👀 Pull request received. I will update this pull request when review starts. ClawSweeper review completeClawSweeper finished reviewing this revision. The review result is being finalized. |
|
Codex review: needs maintainer review before merge. Reviewed September 12, 2026, 9:15 PM ET / September 13, 2026, 01:15 UTC. ClawSweeper reviewWhat this changesThe branch fixes Discrawl’s generated documentation identity, adds a renamed-directory regression and CI checks, records the fix, and corrects a Windows test-skip explanation. Merge readiness✅ Ready for maintainer review This PR remains useful: current main and v0.15.0 still derive the documentation identity from the checkout directory. The focused correction has adequate real build evidence and no blocking findings. Priority: P3 Review scores
Verification
How this fits togetherDiscrawl’s documentation builder reads Markdown from a checkout and generates the static website and an index for AI readers. GitHub Pages publishes those generated files. flowchart LR
A[Checkout documentation] --> B[Documentation builder]
C[Fixed product identity and URLs] --> B
B --> D[Website and AI documentation index]
D --> E[GitHub Pages]
F[Renamed-directory regression] --> B
Before mergeNone. Agent review detailsSecurityNone. Review metricsNone. Technical reviewBest possible solution: Keep the documentation identity explicit alongside the canonical URLs and retain the renamed-directory regression. Do we have a high-confidence way to reproduce the issue? Yes, source establishes that building current main from a differently named checkout writes that directory name into llms.txt. This read-only review did not execute the builder. Is this the best way to solve the issue? Yes, an explicit product name matches the existing fixed branding and URLs without introducing configuration or another identity source. AGENTS.md: not found in the target repository. Codex review notes: model internal, reasoning medium; reviewed against 6169f2125e3d. LabelsLabel changes:
Label justifications:
EvidenceWhat I checked:
Likely related people:
Rating scale
Overall follows the weaker of proof and patch quality. Workflow
|
What Problem This Solves
Building the docs in a renamed checkout wrote that directory's name into
llms.txtas the product identity.User Impact
The generated documentation index consistently identifies Discrawl and retains its canonical URLs.
Why This Change Was Made
Use the product's explicit name and test a complete build in a renamed fixture directory. Run the regression and a real docs build in CI, and require the regression before Pages builds. Also correct an outdated Windows-lock test explanation that incorrectly claimed locking was a no-op; existing test selection and assertions are retained.
Evidence
# renamed-discrawl-...and the same incorrect description.node --test scripts/build-docs-site.test.mjspassed; a realnode scripts/build-docs-site.mjsinvocation from thedocsworktree generated:metadata --jsonschema checks passed.