Skip to content

Add CONTENT-GUIDE.md: how AI agents edit doc/*.md safely - #103

Closed
sn0wm1ku wants to merge 1 commit into
mainfrom
content-ai-guide
Closed

sn0wm1ku wants to merge 1 commit into
mainfrom
content-ai-guide

Conversation

@sn0wm1ku

@sn0wm1ku sn0wm1ku commented Aug 28, 2026 •

Copy link
Copy Markdown
Member

Superseded by #105, which carries the identical two-file change on a branch opened from issue #104. Closing this one.

🤖 Closed by Claude Code

doc/ pages now carry a schema-validated frontmatter block, so a plain
markdown file dropped in fails the Astro content collection and never
reaches the Worker. Documents the exact frontmatter contract, slug/parent/
sort/visibility rules, what a body may contain (no raw HTML), the
add/rename/delete recipes, the gates, and the split between the live
Worker deploy and the still-running GitHub Pages pipeline.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01FgJHpbomqG9v26obEFEonp
Copilot AI lite review requested due to automatic review settings August 28, 2026 03:49
@github-actions github-actions Bot added the ci-testing Enable a GitHub Action for unit testing on a pull request. label Aug 28, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a dedicated, AI-agent-focused guide for safely editing doc/*.md handbook pages under the Astro content-collection constraints, and links it from CLAUDE.md so it’s discoverable before any doc/ edits.

Changes:

  • Add CONTENT-GUIDE.md documenting required frontmatter schema, slug/parent/sort/visibility rules, supported Markdown features, and content workflows.
  • Document required local gates (pnpm check/test/guard/build) and explain how content ships via the Cloudflare Worker vs the legacy VitePress Pages pipeline.
  • Update CLAUDE.md to point contributors/agents to CONTENT-GUIDE.md before editing doc/*.md.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
CONTENT-GUIDE.md New guide describing the content schema contract, authoring rules, and release pipeline for doc/*.md pages.
CLAUDE.md Adds an upfront pointer to the new content editing guide for doc/*.md changes.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread CONTENT-GUIDE.md
| `parent` | no | Slug of the parent page, **in the same section**. A parent in another section (or a missing one) silently makes the page top-level. Nesting is capped at 4 levels. |
| `nav_label` | no | Quoted string; sidebar label when it should differ from `title`. Empty string = fall back to `title`. |
| `sort` | no (defaults 0) | Number. Orders pages within a section **and** orders the sections themselves (a section sits where its lowest-`sort` page falls). |
| `visibility` | no (defaults `internal`) | `public` (anyone) or `internal` (signed-in only). **Fails closed** — a typo means internal. |
Comment thread CONTENT-GUIDE.md
- Allowed: GitHub-flavoured markdown (tables, task lists, strikethrough),
fenced code, `:::info` / `:::tip` / `:::warning` / `:::danger` / `:::note` /
`:::caution` / `:::important` / `:::details` callouts (with or without a
label), ` ```mermaid ` diagrams, and `[[TOC]]` on its own line for an
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci-testing Enable a GitHub Action for unit testing on a pull request.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants