Maintaining This Guide

Maintaining this guide

This guide lives in the waccamaw/dotorg wiki so anyone with GitHub access can read it, review it, and seed one-pagers from it. It's meant to track the live platform — here's how it stays current.

Editing

The wiki is a git repo. Edit in the GitHub web UI (the Edit button on any page), or clone and push:

git clone https://github.com/waccamaw/dotorg.wiki.git
# edit the .md pages, then:
git commit -am "guide: …" && git push

Page names map to files: Getting-Started.md → the "Getting Started" page. Links between pages use the page name without extension: [Getting Started](Getting-Started). The left nav is _Sidebar.md.

Screenshots — PII-safe, generated

Screenshots come from a local copy of the platform (the members-service dev stack), which runs on seeded/example data and never touches production member data. That lets the guide show the real gated pages without exposing anyone.

The capture script lives at scripts/capture-screenshots.mjs in this wiki repo:

# 1. Start the dev stack with dev-login enabled (serves :8787, seeded + corpus):
cd ~/repos/micro.blog/waccamaw/apps/members-service
ENVIRONMENT=local DEV_LOGIN=1 just dev-stack

# 2. In another shell, from a clone of this wiki:
npm install playwright && npx playwright install chromium
node scripts/capture-screenshots.mjs        # → images/
git commit -am "guide: refresh screenshots" && git push

It signs in as leadership (via the dev-only /api/dev-login), visits each gated page, and writes PNGs into images/. The current images are branded placeholders until the first real capture run.

As part of a release

The durable fix for doc rot is to update the guide when you ship. There's a companion Claude skill, waccamaw-user-guide, meant to be run as part of each platform release: it diffs the member-facing routes against this guide, regenerates the screenshots, and updates the affected pages so the docs ship with the code.

When you cut a vX.Y.Z release of any waccamaw service, run the waccamaw-user-guide skill.

---

Back to Home.