Refresh README + ARCHITECTURE for the shipped feature set#59
Merged
Conversation
The front-door docs lagged the code before a contributor review: the README status line was pinned to v0.10.0 and its delegation bullet described the old local-only behavior, and ARCHITECTURE (stamped v0.9.0) still called the per-parent-task tree "deferred" though it shipped in v0.15.0. Make the README status version-agnostic (link releases + CHANGELOG), describe the full scatter-gather capability, and update ARCHITECTURE to reflect the tree as shipped. Docs-only.
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.
What
Bring the front-door docs in line with the shipped code before a contributor reviews the repo:
pinned
v0.10.0that drifts); the delegation bullet now describes the full scatter-gathercapability (by id / by capability, concurrent fan-out, metered + parent-task linkage).
v0.15.0(wasv0.9.0); the per-parent-task-tree passages that stillsaid "deferred / the remaining stretch" now describe it as shipped (the
TANGLEBRAIN_TASK_IDpropagation mechanism).
Why
The code is fully published, but these docs understated the project and one passage was factually wrong
(called a shipped feature "deferred"). A friend/evaluator reads README + ARCHITECTURE first.
Test plan
Docs-only; no code change. CI (
make test) must stay green.