diff --git a/AGENTS.md b/AGENTS.md index 9460ae1..d27da95 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -51,3 +51,9 @@ Invoke as `/contextdocs:command-name` in Claude Code, or as prompts in Codex CLI - `content-filter-guard.sh` — Write guard for high-risk OSS files - `context-guard-stop.sh` — session-end context doc nudge (Tier 1) - `context-commit-guard.sh` — pre-commit context doc enforcement (Tier 2) + +## Synced Documentation Paths + +These paths are consumed by external sync pipelines. Treat as protected — the upstream build fails if they go missing. + +- `docs/faq/index.md` — FAQ scaffold for the help-centre FAQPage schema (issue #25). Synced to `littlebearapps.com/help/contextdocs/faq/` by the marketing-site `scripts/docs-sync.config.ts` mapping under `contextdocs`. **Do not delete or move.** **Update only when** an answer goes stale (new install path, retired feature, top support driver becomes a new question) — not on every release. Keep the question set lean: each H2 must end with `?`, every answer must be complete (no placeholders), and Australian English / banned-phrase rules from `.claude/rules/doc-standards.md` apply. diff --git a/CLAUDE.md b/CLAUDE.md index 44f9aff..10d820f 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -45,6 +45,7 @@ Pure Markdown Claude Code plugin — no JavaScript, no Python, no build step, no | `.claude/agents/docs-freshness.md` | Read-only agent — checks documentation freshness, suggests PitchDocs commands *(PitchDocs)* | | `.claude/rules/doc-standards.md` | Auto-loaded quality rule — 4-Question Test, Lobby Principle, banned phrases *(PitchDocs)* | | `.claude/rules/docs-awareness.md` | Auto-loaded trigger map — suggests PitchDocs commands when docs-relevant work is detected *(PitchDocs)* | +| `docs/faq/index.md` | Synced FAQ — emits Schema.org `FAQPage` JSON-LD on `littlebearapps.com/help/contextdocs/faq/` via the marketing-site sync (issue #25). **Do not delete or move** — upstream build hard-fails. **Update only when** an answer goes stale, not on every release | ## Known Limitations