Skip to content

Publishing

Promote a draft to review and open a PR to nepwalk-docs.

Command

management: publish <file>

Example:

management: publish docs/management/mvp/v1/PRD_v1.md

What it does

  1. Verify the file exists and has status: draft in its frontmatter.
  2. Flip frontmatter to status: review.
  3. Commit to the current branch in nepwalk-management (if the doc lives there) or in nepwalk-docs (the usual case — management writes directly into the docs repo).
  4. Push the branch.
  5. Open a PR against main of nepwalk-docs with:
  6. Title: [management] <doc name> v<N> — review
  7. Body: short summary + link to the upstream idea/PRD it derives from.
  8. Notify the reviewers listed in dept.yaml (if configured).

Pre-publish checklist

  • All template sections filled with real content (no TBD, no placeholders).
  • Upstream docs are at least review (else the doc is built on a moving target).
  • PROJECT_STATE.md reflects the current state (state: to regenerate).
  • No conflicting open PR for the same doc.

After merge

The PR merge changes the doc to status: approved. Downstream prefixes (srs: after prd:, tasks: after srs:) can now run cleanly.