Add a marketing landing page at the GitHub Pages root - #17
Merged
Conversation
The Pages deployment previously served the typedoc API docs at the site root. This adds a hand-rolled, dependency-free landing page (site/index.html) served at the root instead, and moves the API docs under /api/: - The page leads with an interactive demo: six operations (four writes, two reads) showing the instruction, its CLI equivalent, and the result. Every displayed result is verified byte-for-byte against the real engine's output for that instruction. - Sections cover the engine's guarantees, the CLI's read/write command surface, and a "for agents" section with the map -> target -> patch loop. - docs.yml assembles the artifact from site/ plus typedoc output; README and package.json homepage links updated for the new /api/ location. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01VbjyyWq1fcRe3iBg69oxtX
Owner
Author
|
Verification run on this branch: Unit suite (the project's full test surface — no separate integration suite exists): Demo-content verification (every result the landing page displays, checked against the engine built from this branch): Not exercised by these runs: the Pages workflow end-to-end (only runs on push to main; its |
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.
What this does
Replaces the typedoc output at the root of https://coddingtonbear.github.io/markdown-patch/ with a marketing landing page, and moves the API docs under
/api/. The design was chosen from three reviewed mockups (docs-as-landing archetype with an interactive demo hero, plus a CLI read/write section and a "built for agents" section).site/index.html— the whole site: one hand-written, dependency-free static file (no generator, no external requests, light/dark viaprefers-color-scheme,prefers-reduced-motionrespected)..github/workflows/docs.yml— the build now assembles_site/fromsite/(root) + typedoc output (/api/) and uploads that instead ofdocs/directly.README.md/package.json— the API-docs link now points at/api/;homepagepoints at the site.Evidence this adds no risk
withinlist append,readTarget,projectMap) are precomputed, and each one was verified byte-for-byte against the real engine built from this branch — including the realversiontoken2b0a04for the demo document. Verification script output: 6/6 PASS.headingsas an array of paths, but the engine actually returns a nested object ({"Weekly Sync": {"Notes": {}, ...}}). The site shows the engine's real output; the README fix is tracked separately.src/is untouched; the full suite passes (20 suites, 511 tests).cp -R site/. _site/ && cp -R docs/. _site/api/) and produces the expected layout:index.htmlat root, typedoc tree underapi/.Known trade-offs / honest gaps
/<page>(typedoc'sclasses/…,interfaces/…) moves to/api/<page>. No redirects are added; anything deep-linking the old paths (including search-engine results) will 404 until re-crawled.cp, run locally above.🤖 Generated with Claude Code
https://claude.ai/code/session_01VbjyyWq1fcRe3iBg69oxtX