Conversation
Reorganize both language READMEs: a plain-language 'What is the graph' section (node/wave/gate vocabulary) up front, a Features section that collects orchestration, reliability, observability, and beyond-the-graph capabilities (including the v1.0.13-v1.0.15 additions: draft action, execution-location authority, revision view, output file refs), the usage guide, then the engine reference. Engine gains Revisions and Node outputs subsections; the historical/doctrine material moves to a Background section. Wording pass to drop promotional phrasing and inline-bold-label list patterns; workflow-reports/ added to the config table.
docs: restructure README around the graph, features, and usage
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
Promote to main for the next official release. One docs train since v1.0.15 (#276):
docs: restructure README around the graph, features, and usage (PR #277): both language READMEs reorganized to read What is the graph → Features → Using workflows → The engine → Background; the Features section now covers the v1.0.13-v1.0.15 additions (draft action, execution-location authority, revision view, output file refs); the engine reference gains Revisions and Node outputs subsections; wording pass throughout.
Docs-only diff — no code changes.
Dev validation
dev @ merge of #277: Typecheck gate CLEAN (pre-commit full typecheck 29/29); full dev suite green on the previous head; README changes cannot affect unit/e2e outcomes.
Release plan
On merge: dispatch release-fork from main (official). Release notes: documentation rework entry.