Serve /quickstart.md as plain markdown - #609
Merged
Merged
Conversation
Honor the append-.md rule on the top-level quickstart page agents are told to read first, and pin the suffix lookup so a route refactor cannot drop it. Issue: SPL-401 Co-authored-by: Isaac Suttell <isaac@zaks.io>
|
Important Review skippedAuto reviews are disabled on this repository. To trigger a review, include ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Team Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Comment |
isuttell
marked this pull request as ready for review
September 16, 2026 17:27
Issue: SPL-401 Co-authored-by: Isaac Suttell <isaac@zaks.io>
useotto-dev Bot
added a commit
that referenced
this pull request
Sep 17, 2026
… serves Since #609 the Worker answers every `<page>.md` URL before TanStack Start runs, so the five `[.]md.ts` file routes were unreachable. The dynamic twins (SDK topics, error codes) never had file routes at all. One handler now serves all of them. The docs link linter used those file routes as its proof that a markdown twin exists. It now applies one rule to every markdown URL: strip `.md` and require the HTML page to be a route, which is how it already accepted the dynamic ones. The marketing test that guards the twin invariant walks the canonical page list from the sitemap, so a new page without markdown fails there. Issue: SPL-663 Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
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
GET /quickstart.mdnow returns the same markdown as the rendered/quickstartpage. That honors the "append.mdto any page" promise on the first page published READMEs send agents to.Changes
.mdURL astext/markdownwithout an Accept hint..md, so/quickstart.md===/quickstart===quickstartMarkdown()./quickstart.mdroute matches the existing docs.mdfile-route pattern.llms.txtlistshttps://splitch.dev/quickstart.md.Top-level route sweep
Sitemap HTML pages that are not under
/docs:.mdvariant//.mdllms.txt/ Accept; suffix now resolves/quickstart/quickstart.mdtext/markdown; charset=utf-8, same body as HTML sourceNon-HTML top-level routes left alone:
/health,/llms.txt,/robots.txt,/sitemap.xml,/.well-known/api-catalog.Pinned by
markdown-route.test.tsagainststaticPagePathsfrom the sitemap (["/", "/quickstart"]) and bynegotiate-markdown.test.tsfor GET/HEAD/quickstart.mdwith no Accept header.Risk: LOW
apps/marketingpublic markdown routingTest plan / evidence
pnpm --filter @splitch/marketing exec vitest run src/docs/markdown-route.test.ts src/docs/negotiate-markdown.test.ts src/docs/sitemap.test.ts— 16 passed at 17:32 UTCverify:commitgreen on504915b4verify:pushgreen on push of504915b4Verifygreen on current head504915b4: https://github.com/zaks-io/splitch/actions/runs/35129107857/job/104905370841Verifygreen on implementation headdbcde6d3: https://github.com/zaks-io/splitch/actions/runs/35128267788/job/104902606820ziw-code-review) READY FOR PR ondbcde6d3(implementation). Follow-up504915b4is the sitemap sweep pin only. Author QA is not independent review evidence.Head:
504915b4d2f9643b4fe3ac55f39d4e96b9c59b9dBase / merge-base:
4ccab72d81e751e60ee3e9a8cc6f7fc3e1b68643(origin/main)Issue: SPL-401
Linear Issue: SPL-401
Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.