Add documentation audit wiki and auto-publish workflow - #1
Open
ehharvey wants to merge 4 commits into
Open
Conversation
Documents the 2026-08-19 audit of CivicTechWR's five documentation surfaces: an inventory, twelve drift findings, a proposed ownership model, and a remediation checklist. Source lives in wiki/ and is mirrored to the repo's GitHub Wiki by .github/workflows/publish-wiki.yml on merges to main. The workflow uses only actions/checkout plus plain git, since the org restricts Actions to GitHub-owned, Marketplace-verified, peaceiris/* and ruby/*. It validates the source before publishing (refuses an empty wiki/, a missing Home.md, or nested pages) and detects the wiki's default branch rather than assuming it. Also adds a .gitignore for .env, which was previously untracked but unignored. Co-Authored-By: Claude Opus 5 <[email protected]>
Tabulates 56 processes across seven areas with every location each is defined in. Fewer than half have a single home: 7 have conflicting definitions, 18 are duplicated across locations that broadly agree, and 10 aren't written down anywhere. The sharpest conflict is roles — three structurally different models coexist (per-event shifts in EventRoles.md, per-season ownership on Discourse, standing committees on Discourse), not three stale copies of one list. Co-Authored-By: Claude Opus 5 <[email protected]>
Adds 13 marketing and content processes, and moves social media, blog publishing and the newsletter out of Communications so the index does not duplicate itself. Marketing is the least-documented area: 8 of 13 processes have nothing written down. Two carry risk rather than friction — no photo consent practice while we photograph attendees and publish the results, and a live Mailchimp signup collecting addresses that receive nothing. Totals move to 66 processes: 8 conflicting, 19 duplicated, 23 single source, 16 undocumented. Co-Authored-By: Claude Opus 5 <[email protected]>
Twelve marketing items: two that carry risk and need a decision (photo consent, the newsletter), five documentation gaps, three sequenced for after the content pipeline is proven. Items already tracked on Project 46 are linked rather than restated, per the ownership model — the checklist owns only the policy and documentation gaps the board does not cover. Co-Authored-By: Claude Opus 5 <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the 2026-08-19 audit of CivicTechWR's five documentation surfaces, and wires up automatic publishing to this repo's wiki.
What's here
wiki/— eight pages, published to the repo wiki on merge:Headline findings
Recency throughout is measured by last content change, not last push — two repos look active in the org listing but have had no content change in eleven months.
The workflow
.github/workflows/publish-wiki.ymlmirrorswiki/intocore.wiki.giton pushes tomainthat touchwiki/. Also runnable from the Actions tab.actions/checkoutplus plain git, so it needs no exception to the org's Actions policy (GitHub-owned, Marketplace-verified,peaceiris/*,ruby/*).wiki/is missing, empty, lacksHome.md, or contains nested pages, so a bad merge can't wipe the wiki. All four guards tested.masterwith no setting to change it; pushing amainbranch succeeds butHEADstays onmasterand the branch is ignored. Verified empirically. The workflow reads the real branch at run time, so it keeps working if GitHub ever lifts this.Also
Adds a
.gitignorefor.env— it was untracked but unignored, so a Discourse read-only key was onegit add .away from being committed.Note
Direct edits in the GitHub wiki UI are overwritten on the next merge. That's stated on the wiki itself (
_Footer.md, Editing This Wiki) and in the README.🤖 Generated with Claude Code