docs: reorganize README for progressive disclosure and add use-case i…#530
Merged
docs: reorganize README for progressive disclosure and add use-case i…#530
Conversation
…ndex Restructure the main README.md so beginners find getting-started material first, then task-oriented sections, with implementation reference moved to the end. Add a use-case index table mapping 15 common goals to the right section or subdirectory doc. Consolidate duplicated GUI, local flow, and abstract stage instructions. Fix Google style guide violations: HTML <pre> blocks to markdown fences, underline headings to ## style, bare URLs to descriptive links, "one/we" to second person. Add cross-references between related subdirectory READMEs (optuna<->dse, chisel<->toolchains/scala). Fix typo in optuna/README.md and normalize sram/README.md headings. Signed-off-by: Oyvind <oyvind@users.noreply.github.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.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.
…ndex
Restructure the main README.md so beginners find getting-started material first, then task-oriented sections, with implementation reference moved to the end. Add a use-case index table mapping 15 common goals to the right section or subdirectory doc. Consolidate duplicated GUI, local flow, and abstract stage instructions. Fix Google style guide violations: HTML