Skip to content

docs: sync site for simply-flow and fix stale orchestrator README - #134

Merged
ClayChipps merged 1 commit into
mainfrom
docs/sync-site-and-design-status
Aug 27, 2026
Merged

docs: sync site for simply-flow and fix stale orchestrator README#134
ClayChipps merged 1 commit into
mainfrom
docs/sync-site-and-design-status

Conversation

@ClayChipps

Copy link
Copy Markdown
Contributor

Summary

Documentation audit after the last two PRs (#131 AT4DX create/set, #133 flow/permissions cleanup),
requested to make sure everything is current — including the static docs site, which turned out to
need more than expected.

  • Registered simply-flow with the docs site. The site does not auto-discover new packages —
    site/scripts/sync-command-reference.mjs's plugin list and site/astro.config.mjs's sidebar both
    needed a manual entry, plus the plugins overview page and getting-started.md's install list.
  • Fixed a pre-existing gap: getting-started.md's install list was missing simply-aep entirely
    (unrelated to this round of work, just found while auditing the same file).
  • Regenerated packages/simply/README.md, which was badly stale — missing entire plugins' worth
    of commands (simply-aep, simply-sobject, simply-community url set, and more), not just the
    recent Flow/AT4DX create/set additions. Unlike command-snapshot.json, this file has no
    automatic regeneration step, and nobody had run pnpm run readme there in a while.
  • Re-synced every site command-reference page from the now-correct package READMEs. This picked
    up drift going back to at least PR feat: add domain-process-binding create/set commands #131 — the AT4DX create/set commands were never synced to the
    site's tracked .md files (the deployed site was never wrong, since docs.yml re-syncs before
    every build, but the repo's own copies had drifted).
  • Marked design docs 0012 and 0013 Implemented with their PR numbers, and updated the design doc
    index.
  • Corrected CLAUDE.md's docs-site guidance, which overstated the automation — it didn't mention
    that a brand-new package needs manual site registration, or that the tracked site/ source files
    don't self-update just because the deployed site does.

Test plan

  • pnpm --filter site run sync && pnpm --filter site run build — clean build, 33 pages, including
    the new /plugins/simply-flow/ page
  • Root pnpm run build/pnpm test across all 16 projects passes (ran as part of the pre-push
    hook; one transient npmjs.com rate-limit (HTTP 429) during simply-cicd's link-check on the
    first attempt, unrelated to any change here, resolved on retry)
  • N/A — no source code changes

🤖 Generated with Claude Code

- Register the new simply-flow package with the docs site (it doesn't
  auto-discover new packages): sync-command-reference.mjs's plugin
  list, astro.config.mjs's sidebar, plugins overview page, and
  getting-started's install list. Also filled in getting-started's
  pre-existing missing simply-aep entry.
- Regenerate packages/simply/README.md, which was badly stale — it was
  missing entire plugins' worth of commands (simply-aep, simply-sobject,
  simply-community url set, and more), not just the recent Flow/AT4DX
  create-set additions. Unlike command-snapshot.json, this file has no
  automatic regeneration step.
- Re-sync every site command-reference page from the now-correct
  package READMEs, picking up drift accumulated since at least PR #131
  (AT4DX create/set commands were never synced to the site).
- Mark design docs 0012 and 0013 Implemented with their PR numbers, and
  update the design doc index.
- Correct CLAUDE.md's docs-site guidance, which overstated the
  automation: the deployed site self-corrects on every docs.yml run,
  but the tracked site/ source files and a brand-new package's site
  registration do not.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@ClayChipps
ClayChipps merged commit 7aab885 into main Aug 27, 2026
6 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