Skip to content

Prepare post-merge documentation and safe wiki export - #23

Merged
danielbrownjr merged 1 commit into
mainfrom
docs/post-merge-wiki-prep
Oct 14, 2026
Merged

danielbrownjr merged 1 commit into
mainfrom
docs/post-merge-wiki-prep

Conversation

@danielbrownjr

@danielbrownjr danielbrownjr commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Purpose

Prepare DockerCatAgent's merged foundation documentation and GitHub Wiki publication source after foundation PR #1 merged.

Related tracking: #14 (reviewed wiki publication).

Changes

  • Replace stale draft-PR/feature-branch instructions with source-on-main status in README, roadmap, security/contribution/development/installation guides and wiki navigation pages.
  • Preserve pre-release constraints: no approved license, registry image, certified host/account workflows or production deployment.
  • Retarget README's CI badge to main and run CI for future push events on main.
  • Add scripts/export-wiki.py: accepts only a complete reviewed 40-character Git SHA; reads that exact Git tree; rewrites wiki cross-links and canonical docs links; validates destinations; refuses overwrite; stages an atomic 11-page Markdown export and SHA/hash manifest. No wiki write capability.
  • Add isolated exporter unit tests and CI checks for the actual Git-head wiki export; keep generated wiki-export/ out of the repository.

Evidence / verification

  • Local disposable Git-fixture tests: 4/4 passed for pinned-source export, wiki/docs URLs, no overwrite, missing-link rejection and ignoring uncommitted changes.
  • PR CI must validate the full actual wiki export and the unchanged Docker foundation runtime on the exact branch head; review the jobs before merge.
  • Not yet published: the separate DockerCatAgent.wiki.git repository was not read or modified. Wiki link rewrites use the reviewed source commit, after this PR is merged.

Publication gate / next action

After review and explicit merge of this PR, use its resulting merged SHA for python3 scripts/export-wiki.py --ref <sha> --output ./wiki-export. Inspect existing live wiki pages and the export diff, preserve any maintainer content, copy only the reviewed *.md files, and push the separate wiki repository only with owner authorization. Verify Home/sidebar/navigation and record both source and wiki SHAs. Do not upload manifest.json to the public wiki.

Do not treat merging this documentation PR as approving a software release, image publication, or real-account acceptance.

Exact-head CI verification

  • Commit: d96fb2d4aa9770749e81752a75fbdf6f375a56e5.
  • Foundation CI run 38602142634: static and build-smoke both passed.
  • Four wiki exporter unit tests passed. The actual source export completed: 11 Markdown wiki pages from this exact SHA, with a SHA/hash manifest. No wiki was published.
  • Publishing still requires source merge, inspection of the separate wiki Git remote, and explicit owner authorization. No release/deployment/license decision is implied.

@danielbrownjr
danielbrownjr merged commit db1852e into main Oct 14, 2026
2 checks passed
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