Skip to content

Docs And Website Publishing

Jump to bottom
github-actions[bot] edited this page Jun 13, 2026 · 1 revision

Docs And Website Publishing

This page describes the public documentation flow after a product update. It exists so the website, GitHub README, docs folder, and wiki do not drift apart.

Source Of Truth

Update docs/ first. The website is built from docs/, and this wiki is generated from the same Markdown and screenshots.

Main places to update:

  • docs/user-walkthrough.md for click-by-click workflow changes.
  • docs/download.md for launcher, packaging, and first-run changes.
  • docs/how-gainz-calculates-basis.md for basis methodology changes.
  • docs/guides/*.md for focused import, holdings, audit packet, CPA, and troubleshooting guides.
  • docs/assets/screenshots/ for synthetic screenshots that are safe to publish.
  • README.md when a change affects the GitHub landing page.

Update Flow

  1. Make the product change.
  2. Capture or update synthetic screenshots when the visible workflow changed.
  3. Update the relevant files in docs/.
  4. Update README.md only when the GitHub landing page needs the same information.
  5. Generate the wiki pages locally.
  6. Run tests and whitespace checks.
  7. Commit and push to main.
  8. Verify the GitHub Actions checks and Netlify deploy.
  9. Spot-check the website and wiki links after the automation finishes.

Local Checks

python .\scripts\generate_wiki_home.py --output-dir .\build\wiki
python -m pytest Tests
git diff --check

Automation

  • Netlify builds the public website from docs/ and publishes it at https://cryptogainz.store.
  • .github/workflows/pages.yml is a docs build check, not a GitHub Pages deploy.
  • .github/workflows/sync-wiki.yml regenerates the wiki pages from docs/, removes stale wiki-only pages, and pushes the generated wiki.
  • The wiki should not be manually edited for product docs. Manual edits will be overwritten by the next sync.

Privacy Rule

Only publish synthetic screenshots, demo CSVs, and synthetic sample packets. Never commit or publish personal saves, source tax files, exported audit packets from real data, logs, uploaded CSVs, local plans, credentials, or screenshots that reveal private records.

Public Destinations

Clone this wiki locally