docs: protect synced FAQ path in AGENTS.md and CLAUDE.md#27
docs: protect synced FAQ path in AGENTS.md and CLAUDE.md#27Nathan Schram (nathanschram) merged 1 commit intomainfrom
Conversation
Adds an explicit "Synced Documentation Paths" section to AGENTS.md (canonical) and a Key Files row in CLAUDE.md so future sessions know: - docs/faq/index.md is consumed by the marketing-site sync pipeline (scripts/docs-sync.config.ts under contextdocs). The upstream build hard-fails if the directory goes missing. - Update the FAQ only when an answer goes stale — not on every release. - Existing constraints (each H2 ends with ?, no placeholders, Australian English, banned-phrase rules from doc-standards.md) carry over to every revision. Follow-up to #25 / #26 — keeps the FAQ from being deleted by routine cleanup sweeps and makes the maintenance contract explicit. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Warning Rate limit exceeded
To continue reviewing without waiting, purchase usage credits in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
1 participant
Summary
Follow-up to #25 / #26. Adds explicit "do not delete" + "update only when needed" guardrails for
docs/faq/index.mdso future Claude Code (and other AI tool) sessions don't sweep it away during cleanup or rewrite it on every release.docs/faq/index.mdis, that the marketing-site sync hard-fails without it, and the precise update trigger (an answer goes stale — not every release).Other bridges (
.cursorrules, Copilot instructions,.windsurfrules,.clinerules,GEMINI.md) are not edited because this repo's primary AI consumer is Claude Code itself, and AGENTS.md is the canonical source if those bridges ever get added.Why this is "where needed"
MEMORY.mdis for cross-session learned patterns, not project policy → not the right home..claude/rules/*rules cover context-file hygiene (line budgets, Signal Gate, AGENTS↔bridge consistency). The FAQ is user-facing docs, not a context file → out of scope.content-filter-guard.shonly protect against API content-filter blocks on Write — there's no existing pattern for "do not delete this path" that would benefit from extension here.So: AGENTS.md + CLAUDE.md only. Surgical.
Verification
typosclean ✅bash tests/check-version-consistency.shgreen ✅python3 tests/validate-frontmatter.pygreen ✅Test plan
docs/faq/index.mditself is unchanged and remains live on main.🤖 Generated with Claude Code