docs: improve README examples for easier onboarding#98
Merged
reuvenharrison merged 1 commit intomainfrom Apr 18, 2026
Merged
Conversation
- Add Quick Start section with complete copy-paste workflow - All examples now show full workflow files (name, on, jobs) - Use git-ref PR comparison pattern as primary example - Add fail-on: WARN to breaking changes examples - Replace misleading specs/base.yaml paths with openapi.yaml - Reorder spec paths table with git ref as recommended Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
reuvenharrison
force-pushed
the
docs/readme-improve-examples
branch
from
fc86772 to
fb14ada
Compare
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
name,on,jobs) instead of partial snippetsorigin/${{ github.base_ref }}:openapi.yaml) as the primary pattern instead of misleadingspecs/base.yaml/specs/revision.yamlfail-on: WARNso the workflow actually blocks PRsTest plan
🤖 Generated with Claude Code