Post-Merge Documentation Alignment β Copilot Session PromptΒΆ
USE AFTER: PR #3818 (
0D_base_βmain) is merged INVOKE WITH:@copilot Execute docs/agents/POST_MERGE_ALIGNMENT_PROMPT.mdAGENT DEFINITION:.github/agents/post-merge-doc-alignment-agent.mdESTIMATED DURATION: 1 session (~45 min)
MissionΒΆ
You are performing a post-merge documentation alignment pass for the _codex_ repository.
PR #3818 has just been merged from 0D_base_ into main (sessions S233βS244). This brought 8 new/updated CI scripts, 5 new docs, a new test file, and 5 updated workflows. The live GitHub Pages site at https://aries-serpent.github.io/codex/ must now reflect the merged state.
Your job is to traverse the live site, compare each page to its source, find every piece of stale or missing content, fix it, and verify the MkDocs build is clean.
You must not defer any issue found. Fix everything in this session.
Pre-Flight (Run First)ΒΆ
# 1. Confirm you are on main
git checkout main && git pull origin main
git log --oneline -3
# 2. Confirm the PR #3818 commit is present
git log --oneline | grep "S244"
# 3. Verify MkDocs builds without errors BEFORE your changes
pip install mkdocs mkdocs-material mkdocs-mermaid2-plugin pymdownx --quiet 2>/dev/null
mkdocs build --strict 2>&1 | grep -E "WARNING|ERROR|Done" || echo "Build check complete"
# 4. Run link validator baseline
python scripts/validate_docs_links.py --check 2>/dev/null | tail -5 || echo "Link validator not available"
# 5. Sync tracked files
python3 scripts/ci/sync_tracked_files.py --check
Phase 1 β Traverse Live SiteΒΆ
Navigate the live GitHub Pages site and verify each section. Use web_fetch for content and playwright-browser_navigate + playwright-browser_snapshot to check rendering.
1A. Verify New Pages Render CorrectlyΒΆ
Page 1: CI Rescue Pipeline
Check ALL of the following:
- Page loads (HTTP 200, not 404)
- Title: "CI Rescue Pipeline β Golden Path Documentation"
- All 9 Mermaid diagrams render as SVG (not raw text blocks):
- Β§2
flowchart TDβ Complete Pipeline Flowchart - Β§3
graph LRβ Comment Channel Architecture - Β§4
stateDiagram-v2β Deduplication State Machine - Β§5
sequenceDiagramβ Golden Path Sequence Diagram - Β§6
timelineβ Rescue Comment Lifecycle - Β§7
graph TDβ Workflow Dependency Graph - Β§8
graph LRβ Anti-Pattern Map 1 (RP-004 loop) - Β§8
graph LRβ Anti-Pattern Map 2 (duplicate retriggers) - Β§10
flowchart LRβ New Channel Checklist - Table of Contents sidebar shows all 10 sections
- All internal links work (Β§7 file table links, Β§9 marker reference table)
- Code blocks are syntax-highlighted
If any Mermaid diagram renders as raw text: The mermaid2 plugin or CDN is not loading. Check mkdocs.yml plugin config and docs/_config.yml. The fix is documented in .github/agents/github-pages-manager.md Β§Mermaid CDN.
Page 2: CI/CD Index
URL: https://aries-serpent.github.io/_codex_/ci/INDEX/
OR https://aries-serpent.github.io/_codex_/ci/
CI_RESCUE_PIPELINE.md resolves correctly
Page 3: Homepage
- [ ] "π¨ CI Rescue & Health" section visible in nav sidebar - [ ] "π CI Rescue Pipeline" quick-link present under "π Quick Links β π¨ CI Rescue & Health" - [ ] No broken links in the quick-links section1B. Verify Site NavigationΒΆ
Fetch the nav sidebar on any page and confirm these entries exist:
CI Rescue & Health β NEW (S244)
βββ CI Rescue Pipeline β NEW (S244)
βββ CI/CD Index
βββ Failure Analysis
βββ CI Fix Summary
βββ Root Org Validation
CI/CD Workflows β EXISTING (should still be present)
βββ Workflow Index
βββ Consolidation Guide
βββ Deprecation Plan
βββ Optimization Summary
βββ Cache Architecture
1C. Spot-Check Existing Pages for StalenessΒΆ
For each page below, fetch content and scan for the staleness patterns listed:
| Page URL (relative) | Staleness patterns to scan for |
|---|---|
/ (homepage) |
0D_base_ branch refs, session IDs < S233 in "What's New" |
/CHANGELOG/ |
Verify S244 entry in Unreleased section |
/accountability/AGENT_ACCOUNTABILITY_REPORT/ |
S244 session entry (2026-03-30) |
/ci/CI_RESCUE_PIPELINE/ |
0D_base_ where context should be main (see Β§2C below) |
/evolution/ family |
No changes expected β skip unless build warns |
Phase 2 β Detect and Fix DriftΒΆ
Work through this checklist in order. For each item: detect β fix source file β verify.
2A. Branch Name References in Docs (High Priority)ΒΆ
After merge, 0D_base_ references in documentation should be updated to main except in:
- Historical golden-path sequence diagrams (they describe what happened on the branch)
- Accountability reports (historical record β preserve as-is)
- Session logs (historical β preserve)
Files to check and update where appropriate:
# Find 0D_base_ references in docs (excluding historical/accountability files)
grep -rn "0D_base_" docs/ \
--include="*.md" \
--exclude-dir="accountability" \
--exclude="*SESSION*" \
--exclude="*COGNITIVE_BRAIN_STATUS*" \
--exclude="*aftermath*" \
| grep -v "^Binary"
For each hit, determine: is this a current instruction (fix β main) or historical record (preserve)?
2B. Nav Entry VerificationΒΆ
Run this check to find any mkdocs.yml nav paths that don't resolve to real files:
python3 - << 'EOF'
import yaml, pathlib, sys
nav_yaml = yaml.safe_load(open("mkdocs.yml"))
docs_root = pathlib.Path("docs")
broken = []
def check_nav(node):
if isinstance(node, dict):
for k, v in node.items():
check_nav(v)
elif isinstance(node, list):
for item in node:
check_nav(item)
elif isinstance(node, str) and not node.startswith("http"):
p = docs_root / node
if not p.exists():
broken.append(node)
check_nav(nav_yaml.get("nav", []))
if broken:
print("BROKEN NAV PATHS:")
for b in broken:
print(f" {b}")
sys.exit(1)
else:
print("β
All nav paths resolve to real files")
EOF
Fix any broken paths found.
2C. CI Rescue Pipeline β Contextual 0D_base_ ReviewΒΆ
In docs/ci/CI_RESCUE_PIPELINE.md, review every occurrence of 0D_base_:
- In Mermaid sequence diagram (Β§5): Preserve β these describe what happened historically
- In golden-path step-by-step narrative (Β§5): Preserve β historical account
- In "Related Files" table and rules sections: Update to
mainwhere the instruction refers to the post-merge default branch - In the "CI Rescue Pipeline - Golden Path Documentation" footer: Update "Branch: 0D_base_" references that describe current state (not history)
2D. Verify Script References Are AccurateΒΆ
These scripts are referenced in multiple docs. Confirm each actually exists at the stated path:
for f in \
scripts/ci/generate_coverage_map.py \
scripts/ci/ci_rescue.py \
scripts/ci/auto_fix_common_issues.py \
scripts/ci/sync_tracked_files.py \
scripts/ci/check_cross_references.py \
scripts/ci/check_pr_comments.py \
scripts/ci/session_bootstrap.py; do
[ -f "$f" ] && echo "β
$f" || echo "β MISSING: $f"
done
If any are missing, find the correct path and update all docs referencing the old path.
2E. Verify New Test File Is DocumentedΒΆ
tests/ci/test_generate_coverage_map.py was added in S244 but may not be referenced in testing documentation. Check:
If no results, add a brief reference in docs/ci/CI_RESCUE_PIPELINE.md under "Related Files" table (already present) and optionally in docs/TESTING.md if that file lists CI test modules.
Phase 3 β MkDocs Build VerificationΒΆ
# Full strict build β must produce zero warnings
mkdocs build --strict 2>&1 | tee /tmp/mkdocs_post_align.log
# Summary
echo "--- Build Summary ---"
grep -c "WARNING" /tmp/mkdocs_post_align.log && echo "warnings found" || echo "0 warnings β
"
grep -c "ERROR" /tmp/mkdocs_post_align.log && echo "errors found" || echo "0 errors β
"
grep "Done" /tmp/mkdocs_post_align.log
Common warnings and fixes:
| Warning | Fix |
|---|---|
Doc file 'ci/CI_RESCUE_PIPELINE.md' contains a relative link β¦ does not exist |
Update the link target in the source file |
'CI_RESCUE_PIPELINE.md' is not included in the nav |
Verify mkdocs.yml nav entry path exactly matches filename |
Mermaid graph could not be parsed |
Check for unescaped HTML entities or pipe characters in node labels |
WARNING - Config value 'nav': β¦ is not found |
File was renamed or deleted β update nav or create stub |
Phase 4 β Commit and ReportΒΆ
Commit FormatΒΆ
python3 scripts/ci/sync_tracked_files.py --fix
git add docs/ mkdocs.yml
git commit -m "docs: post-merge alignment β PR #3818 β main (S244-doc-align)
- Update branch refs 0D_base_ β main in non-historical docs
- Verify CI Rescue Pipeline Mermaid diagrams render on live site
- Fix any broken nav entries found
- MkDocs build: 0 warnings
Triggered by: docs/agents/POST_MERGE_ALIGNMENT_PROMPT.md"
Final Report CommentΒΆ
Post this summary as a comment on PR #3818 (or as a new issue if the PR is already merged):
## π Post-Merge Documentation Alignment Complete β S244
**Site:** https://aries-serpent.github.io/_codex_/
**Merged PR:** #3818 (0D_base_ β main, S233βS244)
**Alignment session:** S244-doc-align β {DATE}
### β
New Pages Verified on Live Site
- CI Rescue Pipeline: {STATUS} β {N}/9 Mermaid diagrams rendering
- CI/CD Index: {STATUS}
- Homepage quick-link: {STATUS}
### π Drift Fixes Applied
| Fix | Files | Details |
|-----|-------|---------|
| Branch refs 0D_base_ β main | N | Only in non-historical sections |
| Nav entries | N | All paths verified |
| Script references | N | All exist at stated paths |
| Stale session IDs | N | Updated to S244 |
### π¨ MkDocs Build
- Warnings: 0 β
- Errors: 0 β
- Pages built: N
### π Commit
fix(docs): post-merge alignment β PR #3818 β main Β· {SHORT_SHA}
EscalationΒΆ
If you find issues that cannot be fixed with source edits alone (e.g., the Mermaid CDN is blocked in the Pages environment, or a workflow change is needed), do not defer. Instead:
- Fix what you can in source files
- Open a GitHub Issue tagged
docs+ci-health-alertdescribing the blocker - Post the issue link in your final report comment
Checklist SummaryΒΆ
Phase 1 β Traverse Live Site
[ ] CI Rescue Pipeline page: loads + 9 Mermaid diagrams render
[ ] CI/CD Index page: Pipeline entry at top
[ ] Homepage: quick-link + nav entry present
[ ] Site nav: "CI Rescue & Health" section with 5 entries
Phase 2 β Fix Drift
[ ] Branch refs audit: 0D_base_ β main (non-historical)
[ ] Nav paths: all resolve to real files
[ ] Script paths: all 7 CI scripts exist at documented locations
[ ] test_generate_coverage_map.py referenced in docs
Phase 3 β Build
[ ] mkdocs build --strict: 0 warnings, 0 errors
Phase 4 β Commit + Report
[ ] sync_tracked_files.py --fix: all 5 checks β
[ ] Commit pushed with fix(docs): prefix
[ ] Report comment posted on PR #3818
Created: S244 β 2026-03-30 Β· For use immediately after PR #3818 merges to main
Agent definition: .github/agents/post-merge-doc-alignment-agent.md