docs: mark go and rust frameworks experimental, document both - #993
Conversation
The landing page tiles for the Rust and Go frameworks now carry an "experimental" pill, tooltips that say APIs may change, and links to new documentation sections instead of GitHub. The new sections cover each framework end to end, written against the go/*, derive, and spec PRs currently in flight as if landed: - /rust/: crates and cargo features, args and flags, subcommands and flatten, validation (groups, exclusive, delimiter, relations), help and errors, completions, and spec output via to_kdl() - /go/: usage generate go and the generated structs/Parse, the zero-allocation event parser, binding and typed values, help and error rendering, and completions — including the gaps generated Parse still has (overrides, help printing, completion wiring) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Warning Review limit reached
Next review available in: 4 minutes Limit details: You’ve used all 4 included reviews currently available under your plan. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Central YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (16)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Every page in the new /rust/ and /go/ sections now opens with a draft disclaimer, since parts of what they document are still in open PRs. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Greptile SummaryThe PR adds draft documentation for the experimental Rust and Go frameworks and makes those guides discoverable through the VitePress navigation and landing-page framework tiles.
Confidence Score: 5/5The PR appears safe to merge after the prerequisite framework stacks identified in its description have landed. The navigation and internal documentation links resolve consistently, and no concrete defect remains beyond API mismatches that the PR explicitly acknowledges as dependent on in-flight prerequisite changes. Important Files Changed
Reviews (1): Last reviewed commit: "docs: mark the framework docs as draft" | Re-trigger Greptile |
Instruction counts
No instruction-count regression above 1%. Only instruction counts gate. Wall clock is shown for context — on identical hardware it moves 4-20% run to run. Measured by tak — instruction-counted CLI benchmarks, stored in this repository's git notes. Shadow comparisonParsing
|
What
/rust/(7 pages): getting started (crates, cargo features and their footguns), args and flags (type-driven cardinality, full attribute tables, resolution order), subcommands (Subcommands/Args,flatten,ValueEnum, mounts), validation, help/version/errors, completions, and spec output (to_kdl(), round-trip guarantee, feeding usage-cli)./go/(6 pages): overview with a working quick start (including the help/version/error exit switch),usage generate goand the generated structs/Parse, the zero-allocation event parser, binding and typed values, help pages and error rendering, and completions.Notes
-hprints, matching usage-lib on all 211 of mise's #974, feat(go): render--helptoo, matching usage-lib on all 211 of mise's long pages #975, feat(go): render a failure as something a person can act on #977, feat(go): turn bound text into the type a field wants #978, feat(go): answer what could go where the cursor is #984, feat(go): write an answer the way each shell reads it #989, feat(go): generate a struct per command, and the Parse that fills them #990 (Go). This PR should merge after those.Parsedoes not applyoverrides, does not print help/version itself, and__complete_word__wiring is manual. If any of those change before release, trim the "Current limitations" list on/go/.go/README.mdstill claims the generator and typed front door don't exist yet — stale once feat(go): generate a struct per command, and the Parse that fills them #990 lands; not touched here since it isn't part of the docs site.vitepress buildpasses; prettier run over the changed files.🤖 Generated with Claude Code
Note
Low Risk
Documentation and VitePress theme/config only; no application or library runtime behavior changes.
Overview
Adds first-class Rust and Go framework documentation on the VitePress site and surfaces them from the home page and navigation.
The hero now labels both frameworks as experimental (cyan pill + tooltip), calls them “Experimental reference frameworks,” and links tiles to
/rust/and/go/instead of GitHub. Nav gains a Frameworks dropdown; the sidebar lists seven Rust pages (getting started through spec output) and six Go pages (overview through completions).New draft pages describe derive-based Rust (
Cli/Args, validation, completions,to_kdl()) and spec-generated Go (usage generate go,argvparser, binding, help/errors, manual completion wiring), including honest current limitations (e.g. GoParseskipsoverridesand auto help).Reviewed by Cursor Bugbot for commit d634d9b. Bugbot is set up for automated code reviews on this repo. Configure here.