docs: fix stale Bun prerequisite and add missing subcommand documentation#1022
Draft
cursor[bot] wants to merge 3 commits into
Draft
docs: fix stale Bun prerequisite and add missing subcommand documentation#1022cursor[bot] wants to merge 3 commits into
cursor[bot] wants to merge 3 commits into
Conversation
The build pipeline uses fossilize (Node SEA) + esbuild, not Bun. The generate-docs-sections.ts script was hard-coding Bun as a prerequisite even though packageManager is pnpm and runtime is Node.js. - Update generateDevPrereq() to reference Node.js instead of Bun - Update DEVELOPMENT.md build section to mention fossilize/esbuild - Update generated sections in README.md, contributing.md, library-usage.md Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com>
- Add dashboard revisions/restore examples to dashboard.md fragment - Add issue events subcommand and @latest/@most_frequent selectors to issue.md - Add cli defaults and cli import examples to cli.md fragment - Document auth login --url, --force, --timeout flags in auth.md - Document install script flags and env vars in getting-started.mdx Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com>
Contributor
|
Contributor
Codecov Results 📊✅ Patch coverage is 100.00%. Project has 4287 uncovered lines. Generated by Codecov Action |
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.
Documentation Audit: Gap Report & Fixes
Full audit of the Sentry CLI repository comparing implementation (
src/) to documentation. This PR includes both a detailed gap report (DOCS-AUDIT.md) and fixes for the highest-impact issues.Changes
1. Fix stale Bun prerequisite (Critical)
The build pipeline uses
fossilize(Node SEA) +esbuild— not Bun. ButREADME.md,DEVELOPMENT.md, andcontributing.mdall listed Bun as a development prerequisite.script/generate-docs-sections.ts: UpdatedgenerateDevPrereq()to reference Node.js ≥22.15 instead of Bun. Removed the deadextractBunVersion()function.DEVELOPMENT.md: Changed prerequisite from "Bun installed" to "Node.js v22.15 or later". Updated build section to mention fossilize/esbuild instead of Bun.README.md/contributing.md: Updated generateddev-prereqsections to match.README.md: Updatedlibrary-prereqto remove "or Bun" claim.2. Add missing subcommand examples to fragments
dashboard.md: Added examples forsentry dashboard revisionsandsentry dashboard restore(previously undocumented).issue.md: Addedsentry issue eventssubcommand examples and documented@latest/@most_frequentmagic selectors.cli.md: Addedsentry cli defaultsexamples (was only inconfiguration.md) andsentry cli importexamples (completely undocumented).auth.md: Documented--url(important for self-hosted trust model),--force, and--timeoutflags forsentry auth login.3. Document install script options
getting-started.mdx: Added install script flags (--no-modify-path,--no-completions,--no-agent-skills) and env vars (SENTRY_INSTALL_DIR,SENTRY_INIT) useful for CI/Docker.4. Gap Report (
DOCS-AUDIT.md)A structured report covering all audit categories:
Top 5 prioritized fixes (from the report)
auth loginflags (--url, --force, --timeout)@latest/@most_frequentmagic selectors to issue docs