Objective
Document how branch protection, bot commits, wiki previews, and report previews interact in the Fast Forward development workflow.
Current Limitation
Recent workflow changes rely on PR-scoped previews, bot commits to PR branches, and post-merge publishing. Maintainers need clear documentation for why these flows exist, what permissions are required, and how to resolve common conflicts or blocked merges.
Proposed Work
Add documentation that explains the protected-branch-safe automation model for wiki and reports publishing.
Scope
- Explain why generated wiki content is committed to a PR-scoped wiki branch before merge.
- Explain why the parent repository receives bot commits updating
.github/wiki during PR previews.
- Explain what happens after merge into
main.
- Document common conflict resolution for
.github/wiki submodule pointer conflicts.
- Document report preview access and fallback artifacts.
- Document required workflow permissions at a high level.
Non-goals
- Changing workflow behavior.
- Documenting every GitHub Actions implementation detail.
- Replacing command reference documentation.
Acceptance Criteria
Delivery Criteria
Architectural / Isolation Criteria
Objective
Document how branch protection, bot commits, wiki previews, and report previews interact in the Fast Forward development workflow.
Current Limitation
Recent workflow changes rely on PR-scoped previews, bot commits to PR branches, and post-merge publishing. Maintainers need clear documentation for why these flows exist, what permissions are required, and how to resolve common conflicts or blocked merges.
Proposed Work
Add documentation that explains the protected-branch-safe automation model for wiki and reports publishing.
Scope
.github/wikiduring PR previews.main..github/wikisubmodule pointer conflicts.Non-goals
Acceptance Criteria
Delivery Criteria
.github/wikipointer conflicts.Architectural / Isolation Criteria
main,master, andpr-<number>where relevant.