docs: fix documentation gaps and embed skill files at build time#606
Merged
docs: fix documentation gaps and embed skill files at build time#606
Conversation
Contributor
Semver Impact of This PR🟢 Patch (bug fixes) 📋 Changelog PreviewThis is how your changes will appear in the changelog. New Features ✨
Bug Fixes 🐛Upgrade
Other
Documentation 📚
Internal Changes 🔧
🤖 This preview updates automatically when you update the PR. |
Contributor
|
Contributor
Codecov Results 📊✅ 129 passed | Total: 129 | Pass Rate: 100% | Execution Time: 0ms 📊 Comparison with Base Branch
✨ No test changes detected All tests are passing successfully. ✅ Patch coverage is 100.00%. Project has 1275 uncovered lines. Coverage diff@@ Coverage Diff @@
## main #PR +/-##
==========================================
- Coverage 95.74% 95.73% -0.01%
==========================================
Files 203 204 +1
Lines 29936 29876 -60
Branches 0 0 —
==========================================
+ Hits 28661 28601 -60
- Misses 1275 1275 —
- Partials 0 0 —Generated by Codecov Action |
BYK
force-pushed
the
cursor/sentry-cli-docs-gaps-a5b1
branch
from
457d0d4 to
bcaf09d
Compare
BYK
changed the title
BYK
force-pushed
the
cursor/sentry-cli-docs-gaps-a5b1
branch
from
bcaf09d to
6656366
Compare
BYK
changed the title
BYK
force-pushed
the
cursor/sentry-cli-docs-gaps-a5b1
branch
3 times, most recently
from
106505c to
9316180
Compare
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
Contributor
Author
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Member
|
Fixed the Bugbot finding: removed |
Fix genuine documentation gaps not covered by auto-generation (#569): - Add SENTRY_AUTH_TOKEN/SENTRY_TOKEN to configuration.md - Add SENTRY_INSTALL_DIR/SENTRY_NO_CACHE to configuration.md - Add project:admin scope to DEVELOPMENT.md and self-hosted.md - Expand README commands table from 6 to 14 entries - Fix credential storage path (config.db -> cli.db) in auth docs - Fix SENTRY_AUTH_TOKEN priority label (was marked legacy, is primary) - Add missing examples for auth logout/refresh/token, project create/delete, cli setup - Align curl install flags (-fsS) between README and docs site Embed skill files at build time instead of fetching from GitHub: - generate-skill.ts now produces src/generated/skill-content.ts that inlines all skill file contents as a Map<string, string> - agent-skills.ts imports the embedded content and writes it directly to ~/.claude/skills/ — no network fetch, no URL construction, no REFERENCE_FILES array, no version-pinning logic - check-skill.ts verifies skill-content.ts stays in sync - generate:skill chained before build/dev/typecheck in package.json This eliminates the CLI -> GitHub -> CLI roundtrip where skill files generated from the source code were fetched back from GitHub at runtime.
BYK
force-pushed
the
cursor/sentry-cli-docs-gaps-a5b1
branch
from
9316180 to
4c4b734
Compare
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.
Summary
Fix genuine documentation gaps not covered by the auto-generation infrastructure in #569, and eliminate the CLI → GitHub → CLI roundtrip for skill file installation.
Documentation fixes
SENTRY_AUTH_TOKENandSENTRY_TOKENtoconfiguration.md— primary CI/CD auth variables were missing from the env vars referenceSENTRY_INSTALL_DIRandSENTRY_NO_CACHEtoconfiguration.md— undocumented env varsproject:adminto OAuth scopes inDEVELOPMENT.mdandself-hosted.md— code requests 8 scopes but docs listed only 7; self-hosted users creating API tokens with the documented scopes would get permission errorsauth logout,auth refresh,auth token,project create,project delete,cli setupconfig.db→cli.dbin auth credential storage docsSENTRY_AUTH_TOKENpriority label — was incorrectly marked "legacy"; it is the primary env var-fsS) between README and docs siteEmbed skill files at build time
Previously,
sentry cli setupfetched skill files from GitHub at runtime — fetching content that was generated from the CLI's own source code. This was a roundtrip: the CLI generates skill files from Stricli introspection, they live in the repo, and then the CLI fetches them back from GitHub by URL, using a hardcodedREFERENCE_FILESarray that required codegen to keep in sync.Now:
generate-skill.tsproducessrc/generated/skill-content.tsthat inlines all skill file contents (~47KB) as aMap<string, string>agent-skills.tsimports the embedded content and writes it directly to~/.claude/skills/— no network fetch, no URL construction, no version-pinning logicREFERENCE_FILESarray,getSkillUrl(),fetchSingleFile(),fetchAllSkillFiles(),fetchSkillContent()— all removedgenerate:skillis chained beforebuild/dev/typecheck/testinpackage.json(likegenerate:sdk)check-skill.tsverifiesskill-content.tsstays in sync with generated markdown files