docs: sync site for simply-flow and fix stale orchestrator README - #134
Merged
Conversation
- 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>
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
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.
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.
simply-flowwith the docs site. The site does not auto-discover new packages —site/scripts/sync-command-reference.mjs's plugin list andsite/astro.config.mjs's sidebar bothneeded a manual entry, plus the plugins overview page and
getting-started.md's install list.getting-started.md's install list was missingsimply-aepentirely(unrelated to this round of work, just found while auditing the same file).
packages/simply/README.md, which was badly stale — missing entire plugins' worthof commands (
simply-aep,simply-sobject,simply-community url set, and more), not just therecent Flow/AT4DX
create/setadditions. Unlikecommand-snapshot.json, this file has noautomatic regeneration step, and nobody had run
pnpm run readmethere in a while.up drift going back to at least PR feat: add domain-process-binding create/set commands #131 — the AT4DX
create/setcommands were never synced to thesite's tracked
.mdfiles (the deployed site was never wrong, sincedocs.ymlre-syncs beforeevery build, but the repo's own copies had drifted).
Implementedwith their PR numbers, and updated the design docindex.
CLAUDE.md's docs-site guidance, which overstated the automation — it didn't mentionthat a brand-new package needs manual site registration, or that the tracked
site/source filesdon'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, includingthe new
/plugins/simply-flow/pagepnpm run build/pnpm testacross all 16 projects passes (ran as part of the pre-pushhook; one transient npmjs.com rate-limit (HTTP 429) during
simply-cicd's link-check on thefirst attempt, unrelated to any change here, resolved on retry)
🤖 Generated with Claude Code