Uh oh!
There was an error while loading. Please reload this page.
docs: Phase 3 Part 2 — Fix supporting documentation issues - #1638
Conversation
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>
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
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. Comment |
✅ Template check passed after update. Thanks for fixing the PR description. |
Merge Queue Status
This pull request spent 11 seconds in the queue, including 1 second running CI. Required conditions to merge |
c88ff1c
into
design/release-process-redesign-phase3Uh oh!
There was an error while loading. Please reload this page.
) * 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>
Linked issues
Relates to #1558 (CHILD-016: Documentation Reorganization Plan)
Relates to #1546 (EPIC: Release Process Redesign)
What changed
Audience & placement
Notes
Changelog
Changed
Checklist (Global DoD / PR)
🤖 Generated with Claude Code