Improve documentation clarity and fix duplicate comments in Make command#1432
Open
23F2004693 wants to merge 1 commit intosupabase:mainfrom
Open
Improve documentation clarity and fix duplicate comments in Make command#143223F2004693 wants to merge 1 commit intosupabase:mainfrom
23F2004693 wants to merge 1 commit intosupabase:mainfrom
Conversation
This PR improves documentation clarity in the development setup section: - Fixed duplicate and confusing comments in the `make ci -jN` command - Improved explanations for development dependencies (`uv`, `make`, `docker`, `supabase-cli`) - Minor grammar and clarity improvements No functional changes. Only documentation improvements.
There was a problem hiding this comment.
Pull request overview
This PR updates the root README’s local development documentation to be clearer and remove confusing/duplicated guidance around running make targets (especially parallel CI runs).
Changes:
- Clarifies the development dependency list (
uv,make,docker,supabase-cli) with more explicit explanations. - Simplifies the description of how
makeis used to run commands across packages. - Updates the
make ci -jNnote to better explain parallel execution and provide an example.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - `make` is used for running project commands. | ||
| - `docker` is used for running `postgrest` and `auth` test containers. | ||
| - `supabase-cli` is used for running `storage` and `realtime` test containers. | ||
| - |
There was a problem hiding this comment.
There is an empty bullet item here (- with no content), which renders as a blank list entry and can also make the surrounding Markdown formatting confusing. Remove this list item (use a blank line instead if you want spacing) so the dependency list renders cleanly.
Suggested change
| - |
Author
|
Hi! This PR improves documentation clarity. Happy to make any changes if needed. Thanks! |
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.
This PR improves documentation clarity in the development setup section:
make ci -jNcommanduv,make,docker,supabase-cli)No functional changes. Only documentation improvements.
What kind of change does this PR introduce?
Bug fix, feature, docs update, ...
What is the current behavior?
Please link any relevant issues here.
What is the new behavior?
Feel free to include screenshots if it includes visual changes.
Additional context
Add any other context or screenshots.