Skip to content

Create tracking issues for each document in protocol-specifications-v2/docs/ #113

@ravi-prakash-v

Description

@ravi-prakash-v

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 (including docs/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
  • 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

Assigned: @ravi-prakash-v

Metadata

Metadata

Labels

documentationImprovements or additions to documentationsprint-02Sprint 02 tasks

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions