Skip to content

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.

LocationRole today
plugin/lib/services/docs/site.tsregenGlossaryPage inlines term definitions; no references page
site/astro.config.mjsGlossary is a top-level sidebar entry; no Appendix group
site/src/content/docs/changelog.mdNo D-0009 entry

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.

  1. regenReferencesPage in site.ts, mirroring regenGlossaryPage: loadReferenceRows extracts title/url/summary/related/status; active + Emerging/retired tables.
  2. site/astro.config.mjs: remove the top-level Glossary entry; append Appendix → { Glossary, References } after Changelog.
  3. Tests beside the existing site coverage: page content, idempotency, missing-corpus tolerance.
  4. Changelog entry; Astro build verification.
LocationKindChange
plugin/lib/services/docs/site.tsmodifyregenReferencesPage + dry-run inventory row
site/astro.config.mjsmodifyAppendix sidebar group
plugin/lib/services/docs/tests/generate_site.test.tsmodifyReferences-page coverage
site/src/content/docs/references.mdnewBorn generated
site/src/content/docs/changelog.mdmodifyD-0009 entry
  • AC-1: sdlc docs generate site writes the references page; a second run reports unchanged.
  • AC-2: The sidebar renders a trailing Appendix group containing Glossary and References.
  • AC-3: npm --prefix site run build is green.
  • The Data model page (T-E2B1); the seed corpus (T-XUTL).
  • T-FPSR — entity loading conventions and fixtures land there.

T-FPSR


← Back to Tasks