[deep-report] Add a schema-to-docs parity test for reference/frontmatter.md
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 84/100
- Issue type
- Feature
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- go
- Domain
- documentation, testing
Research direction
Read pkg/parser/schemas/main_workflow_schema.json and docs/src/content/docs/reference/frontmatter.md to understand the schema properties and the page's backticked name: references. Add a Go test that checks each top-level property is documented, with commented justification for any allowlisted exemptions. Done when the test passes for current fields and fails if an undocumented schema field is introduced.
Written by the indexing model from the issue text.
Description
Description
Nothing currently guards against the frontmatter reference page drifting from pkg/parser/schemas/main_workflow_schema.json — the audit that found 11 undocumented fields (see the companion docs issues from this same analysis) had to be done manually. Add a Go test that loads the top-level properties of main_workflow_schema.json and asserts each appears as a backticked `name:` reference in docs/src/content/docs/reference/frontmatter.md. Keep a small, justified allowlist for genuinely internal/deprecated fields (each allowlist entry needs a comment explaining why it's exempt).
Expected Impact
Prevents this exact gap from recurring: any future schema field added without a corresponding docs update fails CI immediately instead of silently drifting for months.
Suggested Agent
GitHub Copilot coding agent (Go test + parser package).
Estimated Effort
Medium (1-4 hours)
Data Source
DeepReport Intelligence Briefing — 2026-09-30, sourced from Repository Quality Improvement Report #64505 (Task 3, marked High priority by the source report).
Generated by 🔬 Deep Report · claude · agent · 311.3 AIC · ⌖ 8.86 AIC · ⊞ 7.3K · ◷
- expires on Oct 2, 2026, 10:46 AM UTC-08:00
- Dominant language
- Go
- Stars
- 5.3k
- Forks
- 568
- Avg merge
- 5h 57m
- Merged PRs (30d)
- 647
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- Ships a Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from github/gh-aw
-
agentic-workflows
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
automation documentation
Difficulty 1/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
automation code-quality cookie improvement quick-win task-mining
Difficulty 1/5 Under an hour Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
automation code-quality cookie improvement quick-win task-mining
Difficulty 2/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
automation code-quality cookie improvement quick-win task-mining
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
status: ready for dev
Difficulty 1/5 1-3 hours Newbie friendliness 92/100
hyperledger-labs/fabric-smart-client#2004 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
apache/datasketches-go#189 ·
Maintainers usually reply within 1 day