docs: add docs/faq/index.md for help-centre FAQPage schema#26
docs: add docs/faq/index.md for help-centre FAQPage schema#26Nathan Schram (nathanschram) merged 3 commits intomainfrom
Conversation
Adds a dedicated FAQ scaffold so the marketing-site sync can fetch it and emit Schema.org `FAQPage` JSON-LD on the rendered help page. Closes #25 once the coordinated one-line PR lands in littlebearapps/littlebearapps.com (`scripts/docs-sync.config.ts`). The FAQ contains 9 question-shaped H2s (acceptance criteria: ≥7), each sourced from existing repo content (README, troubleshooting, getting-started, CLAUDE.md). No placeholders, no invented features. 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. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✨ 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 |
The lead-in cross-link to https://littlebearapps.com/help/contextdocs/faq/ 404s in CI because the marketing-site sync mapping hasn't shipped yet (see issue #25 — the coordinated PR follows this one). Switch the URL from an autolink to inline code so lychee skips it; the human-readable hint remains. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The 1.5.0 release bumped plugin.json, README badge, llms.txt, and docs/guides/troubleshooting.md, but the root SKILL.md was missed because it lacked a release-please marker. Sync it to 1.5.0 and add the x-release-please-version marker so future releases update it automatically. This unblocks the consistency check on PR #26 and prevents the same drift recurring on the next release. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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>
Summary
docs/faq/index.mdwith 9 question-shaped H2s (acceptance criteria: ≥7), each backed by real content already in this repo — no placeholders, no invented features.docs/guides/troubleshooting.md(platform matrix, headless-mode, existing FAQ entries),docs/guides/getting-started.md(lifecycle, Context Guard, verify),CLAUDE.md(Known Limitations, PitchDocs relationship).FAQPageJSON-LD on the rendered help page.Closes #25 (jointly with the coordinated marketing-site PR — see below).
Coordinated PR (must land together)
littlebearapps/littlebearapps.comneeds a one-line addition toscripts/docs-sync.config.tsunder thecontextdocsentry:Suggested merge order: this PR first, then the marketing-site mapping PR. The site sync hard-fails if the config references a directory that doesn't exist on the upstream branch.
Question set
claude -pheadless mode?Standards compliance
_typos.tomlandCLAUDE.md) —typosclean..claude/rules/doc-standards.md) — banned-phrase scan returned zero hits (leverage,seamless,robust,comprehensive, etc.).##heading ends with?and starts with How / What / Why / Can.docs/guides/troubleshooting.md. Sync pipeline injectscategory: faq,tool: contextdocs, and dates automatically.Test plan
typos docs/faq/index.md— clean (verified locally).grep -c '^## ' docs/faq/index.mdreturns ≥7 (verified: 9).?(verified locally).TODO/placeholderhits (verified locally).<script type="application/ld+json">FAQPageblock.Out of scope
feature/help-seo-geo-items-1-4inlittlebearapps/littlebearapps.com).GEMINI.mdreferences, modified skill SKILL.md files) — unrelated to this issue, flagged for separate triage.🤖 Generated with Claude Code