-
Notifications
You must be signed in to change notification settings - Fork 9
Create tracking issues for each document in protocol-specifications-v2/docs/ #113
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationsprint-02Sprint 02 tasksSprint 02 tasks
Milestone
Description
Context
Sprint 02 — Documentation hygiene for beckn/protocol-specifications-v2.
The docs/ directory contains design documents, governance guides, and spec artefacts that have no corresponding GitHub tracking issues. Without issues, there is no clear owner, no milestone, and no way to track whether each document is current.
Problem
Documents in docs/ (and sub-directories) were created during earlier phases but have never been formally tracked per-file. Some may be stale or incomplete relative to the current two-tier API architecture (transport layer frozen, schema registry evolving separately).
Tasks
- List all files in
docs/and sub-directories (includingdocs/governance/) - For each document, create a GitHub issue:
- Title:
"Update/review <filename>: <short description>" - Body: current status, what needs updating, acceptance criteria
- Assignee: @ravi-prakash-v
- Labels:
documentation,sprint-02 - Milestone: Sprint 02
- Title:
- Close this meta-tracking issue once all per-document issues are created and linked as sub-issues
Acceptance criteria
- Every file in
docs/has a corresponding open GitHub issue tracking its review/update status - SDF-1 and SDF-2 are already handled separately and should be linked but not duplicated
- Each per-document issue has correct assignee, labels, and milestone
- This issue is closed with a comment listing all created sub-issue links
Related
- S02-G: same task for
beckn/schemas/schema/docs/ - SDF-1 (SDF-1: Move and update STYLE_GUIDE-DRAFT-01.md to draft branch #107): governance/STYLE_GUIDE.md already tracked
- SDF-2 (SDF-2: Move and update CONTRIBUTING_SCHEMAS.md to draft branch #108): governance/CONTRIBUTING_SCHEMAS.md already tracked
Assigned: @ravi-prakash-v
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationsprint-02Sprint 02 tasksSprint 02 tasks