docs: graduate node-distribution plan into a reference doc#146
Merged
Conversation
xujustinj
force-pushed
the
wengine-uninstall
branch
from
5bd5a3c to
be4e0e7
Compare
The node-distribution feature is built (install/uninstall/verify, walk-up discovery), so the planning doc graduates into proper documentation. - Move docs/plans/node-distribution.md -> docs/node-distribution.md, dropping the planning artifacts (Status: Planning, Build order, Settled decisions, Open questions) and folding their rationale into the prose. Open questions become a short "Known limitations / future work" section. - Correct it to match what shipped: the `wengine install` step list now describes the actual uv-add-then-read-metadata flow with rollback (uv has no dry-run, so the "abort before touching" ideal only holds for the PyPI explicit pre-check), and `wengine nodes list` -> `wengine node list` (the real command). - Repoint the docs/plans/node-distribution.md references in config.py, main.py, engine_init.py, and cli.md to the new path. - Link CLI + Node Distribution docs from the README. - Refresh the wengine skill: a "Managing the available node set" section (install/uninstall/verify) and a pointer to the new doc. Co-Authored-By: Claude Opus 4.7 <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
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.
Summary
The node-distribution feature is fully built (install / uninstall / verify, walk-up discovery), so the planning doc graduates into proper reference documentation.
Stacked on #145 (top of the install → verify → uninstall stack) — review/merge those first.
Changes
docs/plans/node-distribution.md→docs/node-distribution.md, dropping the planning artifacts (Status: Planning, Build order, Settled decisions, Open questions) and folding their rationale into the prose. Open questions become a short Known limitations / future work section.wengine installstep list now describes the actual uv-add-then-read-metadata flow with rollback. uv exposes no dry-run, so a distribution's entry-point table is only readable afteruv add— the "abort before touching" ideal holds only for the PyPI explicit pre-check. Added a callout explaining why.wengine nodes list→wengine node list(the real command name).config.py,main.py,engine_init.py, anddocs/cli.md.No code behavior change. Full suite green (640 passed), ruff + pyright clean.
🤖 Generated with Claude Code