Skip to content

docs: add docs/faq/index.md for help-centre FAQPage schema#26

Merged
Nathan Schram (nathanschram) merged 3 commits intomainfrom
feature/issue-25-faq-scaffold
May 6, 2026
Merged

docs: add docs/faq/index.md for help-centre FAQPage schema#26
Nathan Schram (nathanschram) merged 3 commits intomainfrom
feature/issue-25-faq-scaffold

Conversation

@nathanschram
Copy link
Copy Markdown
Member

Summary

  • Adds docs/faq/index.md with 9 question-shaped H2s (acceptance criteria: ≥7), each backed by real content already in this repo — no placeholders, no invented features.
  • Sources: README (value prop, install, tools matrix), 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).
  • Once this lands, the marketing-site sync can fetch the FAQ and emit Schema.org FAQPage JSON-LD on the rendered help page.

Closes #25 (jointly with the coordinated marketing-site PR — see below).

Coordinated PR (must land together)

littlebearapps/littlebearapps.com needs a one-line addition to scripts/docs-sync.config.ts under the contextdocs entry:

{
  source: 'docs/faq',
  category: 'faq',
},

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

# H2
1 What is ContextDocs and why should I use it?
2 How do I install ContextDocs?
3 Which AI coding tools does ContextDocs support?
4 What is the Signal Gate principle and why does it matter?
5 How do I keep my context files up to date?
6 What are Context Guard hooks and when should I install them?
7 Why don't ContextDocs skills auto-trigger in claude -p headless mode?
8 Can I use ContextDocs alongside PitchDocs?
9 How do I check if my context files are healthy?

Standards compliance

  • Australian English (per _typos.toml and CLAUDE.md) — typos clean.
  • Doc standards (.claude/rules/doc-standards.md) — banned-phrase scan returned zero hits (leverage, seamless, robust, comprehensive, etc.).
  • Phrasing rule — every ## heading ends with ? and starts with How / What / Why / Can.
  • Frontmatter — matches the title/description pattern in docs/guides/troubleshooting.md. Sync pipeline injects category: faq, tool: contextdocs, and dates automatically.
  • Lobby Principle — answers are 2–6 sentences with cross-links to deeper docs (troubleshooting, getting-started, support).

Test plan

  • typos docs/faq/index.md — clean (verified locally).
  • grep -c '^## ' docs/faq/index.md returns ≥7 (verified: 9).
  • All H2s end with ? (verified locally).
  • No TODO / placeholder hits (verified locally).
  • Coordinated marketing-site PR opened and linked.
  • After both merge: next deploy renders the help page with a visible <script type="application/ld+json"> FAQPage block.

Out of scope

  • Marketing-site rendering changes (already shipped on feature/help-seo-geo-items-1-4 in littlebearapps/littlebearapps.com).
  • Migrating FAQ-shaped content from other articles in this repo.
  • Pre-existing working-tree drift (GEMINI.md references, modified skill SKILL.md files) — unrelated to this issue, flagged for separate triage.

🤖 Generated with Claude Code

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>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 6, 2026

Warning

Rate limit exceeded

@nathanschram has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 55 minutes and 10 seconds before requesting another review.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5bf508ec-8eaf-4631-853c-2d78e4a81ce5

📥 Commits

Reviewing files that changed from the base of the PR and between dee001d and fda7766.

📒 Files selected for processing (2)
  • SKILL.md
  • docs/faq/index.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/issue-25-faq-scaffold

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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>
@nathanschram Nathan Schram (nathanschram) merged commit 130e103 into main May 6, 2026
10 checks passed
@nathanschram Nathan Schram (nathanschram) deleted the feature/issue-25-faq-scaffold branch May 6, 2026 07:13
Nathan Schram (nathanschram) added a commit that referenced this pull request May 6, 2026
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add docs/faq/index.md for help-centre FAQPage schema

1 participant