Skip to content

Update implementation doc to reflect current review workflow#113

Merged
AdamGohs merged 1 commit into
mainfrom
enhancement/implementation-doc-updates
Apr 11, 2026
Merged

Update implementation doc to reflect current review workflow#113
AdamGohs merged 1 commit into
mainfrom
enhancement/implementation-doc-updates

Conversation

@AdamGohs

Copy link
Copy Markdown
Collaborator

Summary

  • Updated the seven Documentation Guide chapter drafts in `planning/02-documentation-guide-implementation.md` to reflect the current state of the review process: five lanes (new Lane 5: Dev docs), per-individual reviewer gating via the state comment, the `review-workflow` commit status merge gate, backcheck-on-push behavior, and the `admin:advance-to-director` override
  • Rewrote the Site Admin edge cases section: auto-intercept for docs changes on non-`docs/` branches, drive-by approval handling, path-filtered deploys, and the manual workflow_dispatch escape hatch
  • Added an "Infrastructure notes" reference section at the bottom documenting repository labels, branch protection, workflow files, lane detection logic, state comment format, and the GA preview exclusion mechanism — intended as a reference for future planning work and Claude Code sessions

Update the Documentation Guide implementation spec to reflect all the
changes made to the review process and automated workflows today:

- Five lanes (added Lane 5: Dev docs) with content-based detection
- review-workflow commit status as the merge gate, managed by the bot
- Per-individual reviewer gating via hidden state comment; drive-by
  approvals are logged but don't advance the stage
- Stage does not reset when authors push new commits mid-review;
  bot pings assigned reviewers to backcheck
- admin:advance-to-director override label for stuck Lane 1 PRs
- Docs changes from non-docs branches are auto-intercepted
- Non-docs PRs get the admin-may-merge signal from ci-build.yml
- deploy.yml path filter and force-deploy escape hatch
- GA disabled on previews via DOCUSAURUS_IS_PREVIEW env var

Adds an 'Infrastructure notes' section at the bottom as a reference
for future planning work and Claude Code sessions.
@github-actions

Copy link
Copy Markdown

CI build passed for commit fea1b17

This PR does not touch documentation content under docs/, so no multi-stage review is required.

@usace-rmc/docs-admin may merge.

@AdamGohs AdamGohs merged commit c73cba6 into main Apr 11, 2026
3 checks passed
@AdamGohs AdamGohs deleted the enhancement/implementation-doc-updates branch April 11, 2026 20:31
Sign up for free to 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