Skip to content

docs: protect synced FAQ path in AGENTS.md and CLAUDE.md #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Nathan Schram (nathanschram) merged 1 commit into from
May 6, 2026
Merged

docs: protect synced FAQ path in AGENTS.md and CLAUDE.md #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
1 change: 1 addition & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading