T-8YB9-site-references-page-appendix-group
Status: closed/done · Impact: medium · Complexity: small
The reference catalog ships into the docs site as a generated page, and the sidebar gets its Appendix group — the site half of D-0009-reference-entity-and-docs-appendix §4.
| Location | Role today |
|---|---|
plugin/lib/services/docs/site.ts | regenGlossaryPage inlines term definitions; no references page |
site/astro.config.mjs | Glossary is a top-level sidebar entry; no Appendix group |
site/src/content/docs/changelog.md | No D-0009 entry |
Proposed
Section titled “Proposed”sdlc docs generate site writes a References page (summaries inlined
— the site renders no transclusions — url as a real link, cited-by
as code-formatted ids); the sidebar ends with an Appendix group
holding Glossary and References; the changelog records the change.
Approach
Section titled “Approach”regenReferencesPageinsite.ts, mirroringregenGlossaryPage:loadReferenceRowsextracts title/url/summary/related/status; active + Emerging/retired tables.site/astro.config.mjs: remove the top-level Glossary entry; appendAppendix → { Glossary, References }after Changelog.- Tests beside the existing site coverage: page content, idempotency, missing-corpus tolerance.
- Changelog entry; Astro build verification.
Files to touch
Section titled “Files to touch”| Location | Kind | Change |
|---|---|---|
plugin/lib/services/docs/site.ts | modify | regenReferencesPage + dry-run inventory row |
site/astro.config.mjs | modify | Appendix sidebar group |
plugin/lib/services/docs/tests/generate_site.test.ts | modify | References-page coverage |
site/src/content/docs/references.md | new | Born generated |
site/src/content/docs/changelog.md | modify | D-0009 entry |
Acceptance criteria
Section titled “Acceptance criteria”- AC-1:
sdlc docs generate sitewrites the references page; a second run reportsunchanged. - AC-2: The sidebar renders a trailing Appendix group containing Glossary and References.
- AC-3:
npm --prefix site run buildis green.
Out of scope
Section titled “Out of scope”- The Data model page (
T-E2B1); the seed corpus (T-XUTL).
Dependencies
Section titled “Dependencies”T-FPSR— entity loading conventions and fixtures land there.
Discovery context
Section titled “Discovery context”- Extracted from D-0009-reference-entity-and-docs-appendix Migration Phase 3.
Depends on
Section titled “Depends on”T-FPSR