Skip to content

docs(site): frame markdown-contract as a template-engine / CMS foundation#200

Merged
sksizer merged 1 commit into
mainfrom
claude/docs-agent-markdown-generation-70tvgl
Jul 3, 2026
Merged

docs(site): frame markdown-contract as a template-engine / CMS foundation#200
sksizer merged 1 commit into
mainfrom
claude/docs-agent-markdown-generation-70tvgl

Conversation

@sksizer

@sksizer sksizer commented Jul 3, 2026

Copy link
Copy Markdown
Owner

Summary

Sharpens the "What it is not" framing on the docs site — sites/docs/src/content/docs/why.md. The two disclaimers now carry their nuance instead of a flat "no":

  • Not a CMS or site generator — but a foundation one could sit on. A CMS needs create / validate / read over a document type; markdown-contract already delivers validate + read from a single contract, and that same contract is the natural source of create — so a CMS's "new document", save-time validation, and typed reads could all rest on it without drifting apart.
  • Not a template engine — but it could be the basis for one. A contract already declares a document's shape, which can be walked to emit an empty-but-valid skeleton — the exact dual of init, which infers a contract from documents. Emitting shape (never prose) is the core of a template engine.

The original "never generate content" boundary is preserved; the nuance is shape vs. prose.

Scope

This PR is docs-site copy only (one file). The architecture/product exploration this framing points at — a markdown-contract new scaffolding verb — is drafted separately as planning docs in #201 (C-0011 capability + D-0017 decision), so it can land on its own timeline.

@sksizer
sksizer force-pushed the claude/docs-agent-markdown-generation-70tvgl branch from 297559d to e0c78bc Compare July 3, 2026 21:33
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 3, 2026

Copy link
Copy Markdown

Deploying markdown-contract-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7871eef
Status: ✅  Deploy successful!
Preview URL: https://43868e2f.markdown-contract-docs.pages.dev
Branch Preview URL: https://claude-docs-agent-markdown-g.markdown-contract-docs.pages.dev

View logs

@sksizer sksizer changed the title docs: frame markdown-contract as a template-engine / CMS foundation + draft document-scaffolding planning docs(site): frame markdown-contract as a template-engine / CMS foundation Jul 3, 2026
…gine / CMS

Revise the "What it is not" section of the Why page so the CMS and
template-engine disclaimers carry their nuance: markdown-contract is
neither, but the same contract that validates and reads a document is the
primitive both would build on.

- CMS: a CMS needs create/validate/read over a document type;
  markdown-contract already gives validate+read from one contract, so a
  CMS could rest its "new document", save-time validation, and typed reads
  on it without those drifting apart.
- Template engine: a contract declares a document's shape, which can be
  walked to emit an empty-but-valid skeleton — the exact dual of `init`,
  which infers a contract from documents. Emitting shape (never prose) is
  the core of a template engine.
@sksizer
sksizer force-pushed the claude/docs-agent-markdown-generation-70tvgl branch from e0c78bc to 7871eef Compare July 3, 2026 21:36
@sksizer
sksizer merged commit 86649b2 into main Jul 3, 2026
6 checks passed
@sksizer
sksizer deleted the claude/docs-agent-markdown-generation-70tvgl branch July 3, 2026 21:52
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.

1 participant