Repository navigation
Shorten README and publish shared Markdown documentation - #790
Merged
Merged
Conversation
Merged
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
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.
Summary
Keep the README focused on purpose, installation, a first Run and workflow pointers. Preserve the former section anchors and link site explanations to the shared manual. CI rejects stale generated HTML; deployment still serves static files.
The browser test waits for the deferred prompt-reveal script after navigation, including a delayed module request, so a fast CI runner cannot assert visibility before the script loads.
Closes #701
Evidence
After:
cd site && npm testpasses all 13 tests, including no-JavaScript navigation, section anchors, command escaping, repository links and a 320px viewport.docs/guide.mdafter link rebasing and the documented navigation/maintenance edits; no behavior or operations documentation was removed.npm run docs:checkfail with the regeneration command; the unchanged source passes.main.jsreproduced a present but initially hidden target, with no page errors; it became visible once the module finished.After:
cd site && npm testpasses all 13 tests. The focused delayed-load test also passes five consecutive repeats usingnode --test --test-name-pattern="the guide's local links and styles" tests/pages.test.cjs.cargo check --all-targets,cargo fmt --check,cargo clippy --all-targets -- -D warningsand the fullcargo testsuite pass (2 existing ignored tests). The Python release-generator test also passes.Test seams
Merge Danger
Door: two-way
Static documentation and development-only rendering dependencies; no CLI behavior or deployment procedure changes.
Blast Radius: documentation
Unaddressed findings
Standards
None.
Spec
None.
Security
None. A single-session guidance-mode Security review of
git diff e01aa4bb715f5c0c135c20fe332bee4a72e78867...aaa537b427b55052a2b6a48bfb4873e1c4b834d4and supporting code found no introduced Security findings. It covered README/manual changes, Markdown rendering and links, generated HTML, dependency pins and integrity records, browser-test changes, CI and static deployment. The generator reads a fixed repository Markdown file; visitor-controlled request or fragment data does not enter rendering. The generated manual contains no scripts, event handlers, forms or executable URL schemes.node generate-docs.mjs --checkandnode --jitless --max-old-space-size=128 --test --test-isolation=none tests/docs.test.cjspassed in a network-isolated OS sandbox with read-only source/toolchain, an allowlisted environment, scratch-only writes and resource limits. The link test passed with a 60-second CPU limit after an initial 20-second limit terminated it with JIT disabled. No source changes were needed.Security review outcome
No unaddressed introduced findings.
Review coverage
Fresh independent Standards and Spec reviews of the reconciled tree against
main(e01aa4b) each found 0 issues. Both read all 11 changed source/support files. Reports, including each axis's complete files-read list, are saved in.thirdshift-review-mgtGEe/standards.mdand.thirdshift-review-mgtGEe/spec.mdin the Run worktree.Both intentionally left
site/docs/index.htmlunread as generated output. Each revieweddocs/guide.mdandsite/generate-docs.mjs, confirmedcd site && npm run docs:checkpasses, and accepted the browser checks for navigation, escaping, link rewriting, anchors and mobile layout. No other changed file was left unread.Built with codex · gpt-6.1-sol · high