Skip to content

Shorten README and publish shared Markdown documentation - #790

Merged
JacobStephens2 merged 3 commits into
mainfrom
issue-701
Oct 19, 2026
Merged

JacobStephens2 merged 3 commits into
mainfrom
issue-701

Conversation

@JacobStephens2

@JacobStephens2 JacobStephens2 commented Oct 19, 2026 •

Copy link
Copy Markdown
Owner

Summary

README.md (1,213 → 114 lines)
  └─ docs/guide.md: complete manual, with repository-relative links
       └─ npm run docs → site/docs/index.html → thirdshift.app/docs/

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

  • Before: the new homepage-to-manual browser test failed because there was no Documentation link.
    After: cd site && npm test passes all 13 tests, including no-JavaScript navigation, section anchors, command escaping, repository links and a 320px viewport.
  • The complete old manual matches docs/guide.md after link rebasing and the documented navigation/maintenance edits; no behavior or operations documentation was removed.
  • A modified-Markdown probe makes npm run docs:check fail with the regeneration command; the unchanged source passes.
  • Before: the prompt deep-link test failed in CI and on the second local repeat. Delaying main.js reproduced a present but initially hidden target, with no page errors; it became visible once the module finished.
    After: cd site && npm test passes all 13 tests. The focused delayed-load test also passes five consecutive repeats using node --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 warnings and the full cargo test suite pass (2 existing ignored tests). The Python release-generator test also passes.

Test seams

  • Documentation generation CLI: checked-in HTML matches the repository Markdown; repository Markdown links reach files and anchors.
  • Static site in a browser: readers reach the manual from the homepage, follow section links without JavaScript, and read commands on narrow screens.

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...aaa537b427b55052a2b6a48bfb4873e1c4b834d4 and 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 --check and node --jitless --max-old-space-size=128 --test --test-isolation=none tests/docs.test.cjs passed 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.md and .thirdshift-review-mgtGEe/spec.md in the Run worktree.

Both intentionally left site/docs/index.html unread as generated output. Each reviewed docs/guide.md and site/generate-docs.mjs, confirmed cd site && npm run docs:check passes, 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

@JacobStephens2
JacobStephens2 merged commit b3d2f1a into main Oct 19, 2026
18 checks passed
@JacobStephens2
JacobStephens2 deleted the issue-701 branch October 19, 2026 04:19
@JacobStephens2 JacobStephens2 mentioned this pull request Oct 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

make readme more pointer oriented - to docs with more detail, keeping the readme overall more brief

1 participant