Skip to content

feat(website): reframe docs for end users; agent content as plaintext .md - #7

Open
rowinbot wants to merge 1 commit into
mainfrom
docs/agent-md-split
Open

feat(website): reframe docs for end users; agent content as plaintext .md#7
rowinbot wants to merge 1 commit into
mainfrom
docs/agent-md-split

Conversation

@rowinbot

Copy link
Copy Markdown
Contributor

Reframes the rendered docs site for end users; agent-facing content moves to the plaintext .md surface that llms.txt links to.

Mechanism

  • rehype-strip-agent-asides.mjs removes <aside aria-label="For agents"> from the rendered HTML only. The guidance stays in the page source.
  • src/pages/[...slug].md.ts emits a plaintext .md twin of every doc page (raw body, For agents asides intact, internal links rewritten to .md) — and the two agent-only pages, which now have no HTML at all.
  • doc-pipeline.mjs factors the porting transform out of sync-docs.mjs so the HTML generator and the .md endpoint share one source of truth.
  • llms.txt now links to the .md versions (32 links); the GitHub link is untouched.
  • Agent pages → .md-only: agent-runbook / agent-guidance dropped from sync-docs, the sidebar, and .gitignore; human-page links to them repoint to the canonical GitHub doc.

Verified on the build

  • 0 rendered HTML pages leak "For agents"; every .md twin keeps it.
  • Agent pages emit .md, no index.html.
  • All internal links valid; 31 pages built; prose-guard clean.

The remaining mentions of agents in the human pages are factual architecture (calibration is agent-assisted) and are kept on purpose.

🤖 Generated with Claude Code

@netlify

netlify Bot commented Jun 26, 2026

Copy link
Copy Markdown

Deploy Preview for docsxai-dev ready!

Name Link
🔨 Latest commit 31307e4
🔍 Latest deploy log https://app.netlify.com/projects/docsxai-dev/deploys/6a3ee9cc29b3e90008065d9c
😎 Deploy Preview https://deploy-preview-7--docsxai-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

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