Skip to content

docs: Phase 3 Part 2 — Fix supporting documentation issues - #1638

Merged
mergify[bot] merged 1 commit into
design/release-process-redesign-phase3from
docs/release-process-phase3-supporting-docs
Aug 8, 2026
Merged

docs: Phase 3 Part 2 — Fix supporting documentation issues#1638
mergify[bot] merged 1 commit into
design/release-process-redesign-phase3from
docs/release-process-phase3-supporting-docs

Conversation

@ashleyshaw

@ashleyshawashleyshaw commented Aug 8, 2026

Copy link
Copy Markdown
Member

Linked issues

Relates to #1558 (CHILD-016: Documentation Reorganization Plan)
Relates to #1546 (EPIC: Release Process Redesign)

What changed

  • docs/ARCHITECTURE.md (release workflow flow, workflow overview table)
  • docs/AUTOMATION.md (release.yml trigger correction, main branch documentation)
  • docs/DEPLOY.md (added release workflow integration section)

Audience & placement

  • Audience: Engineering leads, documentation maintainers
  • Location: docs/ (multiple files updated)

Notes

  • Fixed alignment issues identified in ADDITIONAL_DOCS_AUDIT.md
  • Ensured consistency across architecture, automation, and deployment guides
  • All workflows now accurately reflect develop-first release flow
  • Added cross-references to RELEASE_PROCESS.md

Changelog

Changed

  • ARCHITECTURE.md: Updated Release Workflow section to show develop-first stacked PR flow
  • ARCHITECTURE.md: Added workflow overview table with all key workflows
  • AUTOMATION.md: Fixed release.yml trigger from "main" to "manual (workflow_dispatch)"
  • AUTOMATION.md: Clarified main branch section for stacked PR flow and post-release sync
  • DEPLOY.md: Added "Integration with Release Workflow" section

Checklist (Global DoD / PR)

  • All AC met and demonstrated
  • Documentation is accurate and reflects implementation
  • Cross-references between docs are consistent
  • No conflicting information across documentation
  • Docs/readme/changelog updated (if user-facing)
  • Code/design reviews approved

🤖 Generated with Claude Code

Fix issues identified in ADDITIONAL_DOCS_AUDIT.md:
**ARCHITECTURE.md:**
- Update Release Workflow data flow to show develop-first stacked PR model
- Replace bullet-point workflow list with table format for clarity
- Add cross-references to RELEASE_PROCESS.md and ADRs
- Include authorization gating in flow diagram
- Reference post-release sync process
**AUTOMATION.md:**
- Fix workflow table: change release.yml trigger from "main" to "manual (workflow_dispatch)"
- Clarify that release workflow doesn't run automatically on push
- Update main branch section to explain stacked PR flow accurately
- Add reference to RELEASE_PROCESS.md for complete release details
- Clarify post-release-sync.yml role in keeping branches in sync
**DEPLOY.md:**
- Add section explaining integration with release workflow
- Clarify that website deploys automatically on each push to develop
- Note that releases trigger website updates via PR #1 merge
- Cross-reference RELEASE_PROCESS.md for release details
These fixes ensure documentation accurately reflects the develop-first release flow
and authorization gating strategy implemented in Phase 1-2.
Related: Phase 3 (Design & Documentation) planning
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
@coderabbitai

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: a545bebb-05f9-4877-a9d8-0b4a892d4b88

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actionsBot commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

✅ Template check passed after update. Thanks for fixing the PR description.

@mergifymergifyBot added the queued label Aug 8, 2026
@mergify

mergifyBot commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

Merge Queue Status

  • Entered queue2026-08-08 09:04 UTC · Rule: dependabot-develop · triggered by merge protections
  • Checks skipped · PR is already up-to-date
  • Merged2026-08-08 09:04 UTC · at 12328c16d80cd321fd3cd8ac35c811d1544ab58a · squash

This pull request spent 11 seconds in the queue, including 1 second running CI.

Required conditions to merge

@mergify
mergifyBot merged commit c88ff1c into design/release-process-redesign-phase3Aug 8, 2026
6 of 7 checks passed
@mergify
mergifyBot deleted the docs/release-process-phase3-supporting-docs branch August 8, 2026 09:04
@mergifymergifyBot removed the queued label Aug 8, 2026
@ashleyshawashleyshaw self-assigned this Aug 8, 2026
@ashleyshawashleyshaw added this to the v1.0 milestone Aug 8, 2026
@ashleyshaw
ashleyshaw restored the docs/release-process-phase3-supporting-docs branch August 8, 2026 09:39
ashleyshaw added a commit that referenced this pull request Aug 8, 2026
)
* docs: Add Architecture Decision Records and flow diagrams for release process
Phase 3 (Design & Documentation) — Part 1:
- Create docs/ADRs/ directory with 4 architectural decisions
- ADR-001: Develop-first stacked PR flow (rationale, alternatives, implementation)
- ADR-002: Authorization gating strategy (role-based, audit logging)
- ADR-003: Post-release sync automation (keep main/develop in sync)
- ADR-004: Rollback & error handling (semi-automated with manual control)
- Add Mermaid flow diagrams to RELEASE_PROCESS.md:
- Full release flow (authorization → publish)
- Authorization validation flow
- Post-release sync flow
- Rollback decision tree
- Cross-reference ADRs from RELEASE_PROCESS.md
- Update version to v3.1.0 (added documentation)
These ADRs document the major design decisions made during Phase 1-2 implementation,
providing context for future maintainers and supporting team training.
Related: ADRs linked to specific sections in RELEASE_PROCESS.md
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
* docs: Fix supporting documentation issues (Phase 3 Part 2) (#1638)
Fix issues identified in ADDITIONAL_DOCS_AUDIT.md:
**ARCHITECTURE.md:**
- Update Release Workflow data flow to show develop-first stacked PR model
- Replace bullet-point workflow list with table format for clarity
- Add cross-references to RELEASE_PROCESS.md and ADRs
- Include authorization gating in flow diagram
- Reference post-release sync process
**AUTOMATION.md:**
- Fix workflow table: change release.yml trigger from "main" to "manual (workflow_dispatch)"
- Clarify that release workflow doesn't run automatically on push
- Update main branch section to explain stacked PR flow accurately
- Add reference to RELEASE_PROCESS.md for complete release details
- Clarify post-release-sync.yml role in keeping branches in sync
**DEPLOY.md:**
- Add section explaining integration with release workflow
- Clarify that website deploys automatically on each push to develop
- Note that releases trigger website updates via PR #1 merge
- Cross-reference RELEASE_PROCESS.md for release details
These fixes ensure documentation accurately reflects the develop-first release flow
and authorization gating strategy implemented in Phase 1-2.
Related: Phase 3 (Design & Documentation) planning
Co-authored-by: Claude Haiku 4.5 <noreply@anthropic.com>
---------
Co-authored-by: Claude Haiku 4.5 <noreply@anthropic.com>
Sign up for freeto 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

@ashleyshaw