Skip to content

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

@nathanschram

Description

Context

The littlebearapps.com help centre now emits Schema.org FAQPage
JSON-LD on any help article whose category: faq frontmatter is set,
or whose body contains ≥3 question-shaped H2s. The category exists in
the help collection schema, but no tool currently has a dedicated
FAQ article
— synced or hand-written. This issue tracks creating
that scaffold for ContextDocs.

The marketing-site infrastructure (FAQPage extractor, author byline,
heading anchors, per-tool llms.txt, sitemap priority bumps, per-tool
OG images) has already shipped on the
feature/help-seo-geo-items-1-4 branch in littlebearapps/littlebearapps.com.
This issue closes the loop with real upstream content so the schema
actually fires for ContextDocs.

What needs to change

1. Create the FAQ scaffold

Path: docs/faq/index.md on main.

The marketing-site sync pipeline injects category: faq, tool: contextdocs, and dates automatically — only the article H1 and body
need to live in the file. Suggested structure:

---
title: "ContextDocs — Frequently Asked Questions"
description: "Common questions about ContextDocs: installation, usage, troubleshooting, and design choices."
---

# Frequently Asked Questions

> Quick answers to the questions users ask most often. Also surfaced at
> <https://littlebearapps.com/help/contextdocs/faq/>.

## How do I install ContextDocs?## Does ContextDocs work with …?## Where does my data go?## What happens if … fails?## How do I uninstall ContextDocs?## Why does ContextDocs need … access?## How do I update ContextDocs?

Aim for at least 7 question/answer pairs. The FAQPage schema fires at
≥2 for category: faq articles, but more breadth means more citation
surface.

2. Coordinated mapping in littlebearapps/littlebearapps.com

The marketing site needs a one-line addition to scripts/docs-sync.config.ts
under the contextdocs entry:

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

Without it, the sync pipeline doesn't know to fetch the FAQ. The
upstream PR (here) and the site-side mapping PR must land together

the site sync hard-fails (build error) if the config references a
directory that doesn't exist on the upstream branch.

Suggested order:

  1. Land this scaffold to main first.
  2. Open the matching one-line PR in littlebearapps/littlebearapps.com.
  3. Next nightly sync (or manual trigger) picks up the FAQ and the schema
    appears live.

Why this matters

  • AI-citation surface. FAQPage JSON-LD is one of the structured
    data types most frequently referenced by ChatGPT, Perplexity, and
    Google AI Overviews. Without dedicated FAQ content the site relies on
    incidental section-level detection (currently 3 articles across all
    tools).
  • Search snippets. Google occasionally renders FAQ-rich SERP
    results from FAQPage schema (policy permitting).
  • Schema is already wired up. The marketing site already extracts
    question-shaped H2s and emits FAQPage. Once the FAQ file exists and
    the mapping lands, the schema appears with zero further code.

Acceptance criteria

  • docs/faq/index.md exists on main.
  • At least 7 ## headings, each phrased as a question (ends with
    ? or starts with How / What / Why / When / Where / Can / Do /
    Does / Is / Are / Should / Will).
  • Each question has a complete answer (no TODO, no
    [placeholder]).
  • Coordinated PR in littlebearapps/littlebearapps.com adds the
    docs/faq mapping under contextdocs in
    scripts/docs-sync.config.ts.
  • After both PRs merge: the next deploy renders
    https://littlebearapps.com/help/contextdocs/index/ (or whatever
    slug the sync produces — single-file directories typically map to
    the parent slug) with a visible <script type="application/ld+json">
    FAQPage block in the page source.

Sources for content

When drafting, mine real channels rather than inventing FAQs:

  • This repo's GitHub Discussions (open + answered)
  • This repo's GitHub Issues with question, support, or
    documentation labels
  • README and getting-started common-questions sections
  • Anything Nathan has answered on Bluesky / Mastodon about ContextDocs
  • Telegram / Discord / community channels (if applicable)

Out of scope

  • Marketing-site rendering changes (already shipped).
  • Migrating existing scattered FAQ-shaped content from other articles in
    this repo (separate exercise).
  • Drafting full FAQ content within this issue's description — do that in
    the PR.

References

  • Marketing-site implementation plan: docs/plans/help-section-seo-geo-implementation-plan.md
    on the feature/help-seo-geo-items-1-4 branch in
    littlebearapps/littlebearapps.com.
  • Items SEO-1 (FAQPage schema gap) and GEO-9 (FAQ-style structured
    content) in the audit.
  • Schema spec: https://schema.org/FAQPage

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions