docs: fix CLI option examples#373
Open
JONASXZB wants to merge 4 commits into
Open
Conversation
Greptile SummaryThis PR fixes four documentation errors in the CLI reference page where the documented flag names and sort values diverged from what the CLI and API actually accept.
Confidence Score: 5/5Safe to merge — all four documentation corrections are verified against the live CLI source and Zod validation schemas. Every changed value was cross-checked: budget flag names match cli/src/commands/gigs.ts option definitions, gig sort values match the gigsFiltersSchema enum in src/lib/validations.ts, and all five feed sort values (hot, new, top, rising, following) now match feedFiltersSchema exactly. No logic or runtime code is touched. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[CLI Docs Page] --> B[Gigs Section]
A --> C[Feed Section]
B --> B1["--budget-min / --budget-max\n✅ matches gigs.ts CLI options"]
B --> B2["Sort: newest, oldest, budget_high, budget_low\n✅ matches gigsFiltersSchema enum"]
C --> C1["Sort: hot, new, top, rising, following\n✅ matches feedFiltersSchema enum"]
C --> C2["Example: ugig feed --sort rising\n✅ valid enum value"]
Reviews (4): Last reviewed commit: "docs: include following feed sort option" | Re-trigger Greptile |
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.
Summary
recentgig sort option with the supportednewestvalueoldestgig sort option so the docs match CLI help and validation--min-budget/--max-budgetto--budget-min/--budget-maxtrendingsort example with implemented feed sort values and a validrisingexamplefollowingfeed sort option from the shared validation schemaFixes #372.
Verification
https://ugig.net/api/gigs?sort=recent&limit=1returns 400https://ugig.net/api/gigs?sort=newest&limit=1returns 200https://ugig.net/api/feed?sort=trending&limit=1returns 400https://ugig.net/api/feed?sort=hot&limit=1returns 200https://ugig.net/api/feed?sort=following&limit=1is accepted as a valid sort and reaches auth handling (401 login required), rather than validation failurecli/src/commands/gigs.tsdefines--budget-minand--budget-maxgit diff --check -- src/app/docs/cli/page.tsxDocs-only change; no build was run.