Skip to content

docs: add docs/plans convention doc (#Phase2 WI-1)#483

Merged
primetimetank21 merged 2 commits into
developfrom
docs/plans-convention-readme
Jun 13, 2026
Merged

docs: add docs/plans convention doc (#Phase2 WI-1)#483
primetimetank21 merged 2 commits into
developfrom
docs/plans-convention-readme

Conversation

@primetimetank21

Copy link
Copy Markdown
Owner

Implements WI-1 of the approved Phase 2 docs-alignment plan.

This PR adds the canonical convention doc for all future plan documents in docs/plans/.
It defines:

  • YAML front-matter schema (issue, title, status, created, updated) with locked status
    vocabulary (draft, ready, in-progress, implemented, superseded)
  • File-naming convention (NNN-slug.md)
  • Flat-layout rationale
  • Grill-history policy (no review changelogs; git log + front-matter updated sufficient)
  • What belongs / what does NOT belong lists (no cast names, no version changelogs, no
    process notes)

This doc is the reference for WI-2 (front-matter normalization) and WI-3 (grill-changelog
scrub).

Verification:

  • 1 new file: docs/plans/README.md (81 lines)
  • ASCII-clean: 0 non-ASCII bytes
  • Additive only; no other changes
  • Draft PR status pending review

primetimetank21 and others added 2 commits June 13, 2026 02:44
This implements WI-1 of the approved Phase 2 docs-alignment plan. Defines
the canonical front-matter schema (issue, title, status, created, updated)
and locked status vocabulary (draft, ready, in-progress, implemented, superseded).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@primetimetank21 primetimetank21 marked this pull request as ready for review June 13, 2026 06:56
@primetimetank21 primetimetank21 merged commit 1caac0b into develop Jun 13, 2026
10 checks passed
@primetimetank21 primetimetank21 deleted the docs/plans-convention-readme branch June 13, 2026 06:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant