docs: slim README and fill doc-site gaps - #536
Merged
Merged
Conversation
Trim the root README to a trophy-forward front door: drop the 'Is cascade for you?' section, replace the capabilities and generation tables with a short highlights block plus links, and move contributor conventions to CONTRIBUTING.md. Add task guides for action pins and opt-in companions, anchor the tag grammar concept, and make the components guide discoverable under 'monorepo'. Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
…efault Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
Signed-off-by: Joshua Temple <joshua.temple@stablekernel.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.
Problem
The root README over-says (229 lines of overlapping tables), and a few shipped features have no task guide, so the full surface is hard to discover.
Fix
simulate/graph, and relocate contributor conventions to CONTRIBUTING.md.guides/action-pins.md(action-pin single source + reconcile self-heal) andguides/companions.md(opt-in drift-check, PR preview, verify gate, merge queue).guides/components.mddiscoverable under 'monorepo' via its frontmatter.Verification
ci:-rooted examples;TestSchema_ValidatesREADMEExamplespasses.