Update README examples and example build commands#1554
Merged
Conversation
This was referenced Feb 27, 2026
This was referenced Feb 27, 2026
|
Checks from Comment Test PR #1558 |
|
Checks from Request Change Test PR #1557 |
|
Checks from Push Test PR #1555
|
|
Checks from Push as App Test PR #1556 |
There was a problem hiding this comment.
Pull request overview
This pull request updates the README.md documentation to make examples more realistic and practical. The changes add a common formatter workflow scenario and replace placeholder build commands with actual, commonly-used commands.
Changes:
- Added a new example scenario (#1) demonstrating Prettier/oxfmt formatter usage in CI workflows
- Renumbered existing examples to accommodate the new first example
- Replaced placeholder build command with real-world commands:
yarn prettier -w .andyarn graphql-codegen --config codegen.ts
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Motivation
Description
oxfmtexample to the usage scenarios and renumber the example list.yarn prettier -w .andyarn graphql-codegen --config codegen.tsin the example workflow.Testing
Codex Task