docs: restructure README with TOC and Usage / Examples / Customize / Resources sections#5
Closed
sundram-bruno wants to merge 1 commit into
Closed
Conversation
…s sections + TOC Reorganises the README to a clearer index-driven structure with a top-level table of contents, and groups the existing content into the standard sections used across mature first-party GitHub Actions. Changes: - New TOC at the top with anchor links to every section. - `Quickstart` → `Usage`. Same content, standard section name. - `Pairing with downstream actions` → `Examples`. The 13 recipes (PR comments, Checks tab, artifact upload, Slack, matrix, soft-fail, forked-PR, mTLS, other CI) are now consistently labelled and listed in the Examples section's own sub-index. - Inputs and Outputs tables moved under a `Customize` parent section, alongside the Behavior notes that previously sat as their own H2. - New `Resources` section linking to Bruno CLI docs, command options, npm package, the main Bruno repo, and GitHub Actions documentation. - Versioning, Troubleshooting, and License remain as their own H2s, also indexed from the TOC. No content removed. Recipe details, exit-code reference, troubleshooting cheatsheet, enterprise pattern, and other CI pointer are all preserved — just reorganised under the new headings. Also drops the introductory line that compared this action's design to other vendors' actions (postmanlabs/postman-cli-action, kong/setup-inso). The design intent the line described is now evident from the structure itself.
Contributor
Author
|
Superseded by the new restructure PR — different section ordering picked (Usage → Customize → Versioning → Examples → Troubleshooting → Resources). |
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.
Reorganises the README to a clearer index-driven structure with a top-level table of contents and groups the existing content into standard sections used across mature first-party GitHub Actions.
What changed
What didn't change
No content removed. Recipe details, exit-code reference, troubleshooting cheatsheet, enterprise pattern, and other CI pointer are all preserved — just reorganised under the new headings.
Also
Drops the introductory line that compared this action's design to other vendors' actions (postmanlabs/postman-cli-action, kong/setup-inso). The design intent the line described is evident from the structure itself; superseded by this restructure. Supersedes #4.