docs: TOC, reorder oasdiff.yaml section, fix boolean-limitation wording#111
Merged
reuvenharrison merged 1 commit intomainfrom May 8, 2026
Merged
docs: TOC, reorder oasdiff.yaml section, fix boolean-limitation wording#111reuvenharrison merged 1 commit intomainfrom
reuvenharrison merged 1 commit intomainfrom
Conversation
Three follow-up tweaks to #110: - Add a Contents TOC at the top so readers can jump to the right section in a now-sizeable README. - Move the "Configuring with oasdiff.yaml" subsection from the start of "Free actions" to the end, so readers see the three actions first and discover the shared config option after. - Fix wording in the Limitation note: the previous version said "boolean flags can only be enabled through an action input" but also "passing composed: 'false' has no effect", which is contra- dictory. The new wording — "action inputs can only turn a boolean flag on, not off" — describes what the entrypoint actually does.
3 tasks
reuvenharrison
added a commit
that referenced
this pull request
May 8, 2026
The documented path (oasdiff.yaml at the repo root) is unconventional for a CI/lint tool. Most tools in this category use a dotfile convention (.eslintrc, .prettierrc, .golangci.yml, .yamllint, etc.). Pulling the section so customers don't adopt the unconventional path and have to migrate later. The CLI lookup will move to .oasdiff.* in a follow-up; documentation will return at that point with the right path. Keeps the rest of the README intact: the TOC structure (only the line for this removed section is dropped), the boolean-limitation wording fix from #111, all action subsections.
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
Three follow-up tweaks to #110, all in README.md:
oasdiff.yaml" subsection from the start of "Free actions" to the end, so readers see the three actions (breaking, changelog, diff) first and discover the shared config option afterwards. Better narrative flow.composed: 'false'has no effect" — contradictory. The new wording — "action inputs can only turn a boolean flag on, not off" — describes what the entrypoint actually does (if [ "$composed" = "true" ]; then flags="$flags -c").Test plan
oasdiff.yamlconfig