Skip to content

[Devops] Branching Strategy - Phase 4 #510

@lowlydba

Description

@lowlydba

Goal

Final editorial pass on all docs. No new procedures — everything is already live from Phases 0–3. This phase makes the docs easier to read and navigate.

Depends on: Phase 3 complete.

Tasks

p4-docs

  • Final pass on docs/branching-strategy.md + docs/versioning.md.
  • Add mermaid diagrams (branch model, trigger × destination flow, release flow).
  • Add end-to-end contributor walkthroughs (normal PR, major-change PR, release).
  • Add FAQ section.
  • Cross-link between docs + CONTRIBUTING.md.

Contributor-facing changes

  • Nothing new procedurally. Docs are nicer to read, with diagrams, walkthroughs, and an FAQ.

Definition of done

  • Diagrams added to both docs
  • Walkthroughs written for: normal PR to main, major-change PR to vnext, release process
  • FAQ covers common questions (what branch do I target? what happens to my PR when vnext rebases? how do I know a release fired?)
  • All docs cross-linked

Metadata

Metadata

Labels

enhancementNew feature or request

Type

No fields configured for Task.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions