Skip to content

Add FAQPage structured data to the FAQ #57

Description

@pushpam2404

Context

faq.html is a well-formed question-and-answer page with no machine-readable markup. Schema.org FAQPage is what lets search engines show the questions directly, and it has to stay in step with the visible content — which is the hard part, not the JSON-LD itself.

What to change

Files: faq.html, plus a generation step and a CI check

Requirements:

  • Add valid FAQPage JSON-LD covering every question on the page
  • Generate it from the markup rather than maintaining it by hand — a hand-written copy will drift the first time somebody edits a question
  • A CI check fails if the structured data and the visible questions disagree
  • Follow Google's rules: only genuine questions, answers must match what the page shows

Acceptance criteria

  • The JSON-LD validates against Google's Rich Results Test
  • It covers every visible question with no extras
  • Adding a question to the HTML and running the generator updates it
  • CI fails when they are out of step
  • Nothing changes visually

How to verify locally

python3 -m http.server 8000

Then open http://localhost:8000.

Difficulty

Advanced. The drift-prevention is the real work.


New here? Comment /claim on this issue and a bot will assign it to you. Then read CONTRIBUTING.md.

Stuck at any point? Comment here saying what you have tried and where it stopped working — that is not an admission of failure, it is how we find out the instructions were unclear. You can also come to a PR Debug Clinic (Oct 12 or Oct 21).

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions