Read the docs from your coding assistant

Read the same source

The documentation is authored in the EmDash Docs collection as Portable Text. Published entries supply the HTML pages, native Markdown copies, public search data and llms.txt. Read those public outputs so humans and assistants use the same article content.

Each article includes product and version scope. Ask your assistant to compare that scope with the repository or installed artifact it is changing. A source-backed example is not proof that another version exports the same contract.

Published articles and available formats

Only published articles appear on the public site. Unpublished drafts are excluded from production HTML, Markdown, search and llms.txt. Local development may preview drafts, but a production documentation request cannot reveal them. Do not use administrative access to work around an unpublished article.

For a published article, use these routes:

Use Copy as Markdown or View as Markdown under a published article's title. The Markdown copy includes its canonical source URL, product and version scope. Start with /llms.txt to discover available articles, or use /docs/search.json. An unpublished or unknown article returns not found; if no articles have been published, llms.txt also returns not found and search returns an empty array.

Ask for evidence before changes

A useful request is: “Find the article for integrating the installed public catalog. Read its version scope and sources, compare them with my project, and explain the mismatch before proposing code.”

Have the assistant follow links to the canonical reference instead of duplicating an API description from memory. For a test checkout, require both provider-confirmed TEST payment and the corresponding Commerce Orders record. Never let a browser return or a generated example become evidence that a payment succeeded.

Public documentation MCP

A public read-only docs MCP is not yet implemented and verified. There is no supported MCP endpoint or connection command to copy. Use the public HTML and Markdown routes for now. Issue #53 tracks the separate MCP work.

An eventual docs MCP must be tested with an actual assistant, including a search and article fetch. Results must include titles, canonical source URLs and version context. Unknown and private article IDs must return no content. Retrieval must not accept arbitrary paths or URLs.

The public docs MCP must expose no CMS, merchant, payment, or mutation tools, and must require no administrative token. Giving an assistant documentation access does not authorize it to modify a store.

Next step

Read the public article for your task and check its version scope before proposing changes. Public Markdown access does not require a CMS token or permission to administer a store.

Sources

• CMS authoring and public output contract
• Documentation launch and remaining MCP acceptance criteria