Commit b3305b6
ci(docs): Add agentic workflows for codebase documentation (#5649)
## Summary
- Add two GitHub Agentic Workflows (`gh aw`) that auto-generate and
maintain developer-facing codebase documentation in `docs/codebase/`
- **`docs-codebase-refresh`**: full regeneration of every doc page,
triggered on merge to main/master or manual dispatch
- **`docs-codebase-update`**: incremental update of only affected pages,
triggered on merge when `sentry_sdk/**`, `MIGRATION_GUIDE.md`, or
`CHANGELOG.md` change
- Both workflows create PRs (never direct commits) for human review
- Includes a portable `BUILD_PLAN.md` designed for reuse across other
Sentry SDKs -- only the SDK Context block changes per language (will
remove later)
### How This Relates to Other Sentry Docs
- **[docs.sentry.io/platforms/\*](https://docs.sentry.io/)** tells users
*what to do* -- setup guides, config options, API usage.
- **[develop.sentry.dev/sdk/](https://develop.sentry.dev/sdk/)** tells
SDK authors *what to build* -- protocol spec, envelope format, required
behaviors.
- **API reference** (Sphinx, TypeDoc, Javadoc, etc.) tells developers
*what the API surface looks like* -- auto-generated from
docstrings/annotations. Lists signatures, parameters, return types.
- **`docs/codebase/*`** (this) explains *what was built and how it
works* -- architecture, data flow, how modules connect, and why.
Generated from full source analysis, not just docstrings. Aimed at SDK
contributors and maintainers.
### Files added
| File | Purpose |
|------|---------|
| `docs/codebase/BUILD_PLAN.md` | Portable blueprint with porting
checklist |
| `docs/codebase/_meta/style-guide.md` | SDK-agnostic formatting rules
and page templates |
| `docs/codebase/_meta/manifest.json` | Empty manifest (populated by
first workflow run) |
| `.github/workflows/docs-codebase-refresh.md` | Full refresh workflow
source |
| `.github/workflows/docs-codebase-update.md` | Incremental update
workflow source |
| `.github/workflows/docs-codebase-*.lock.yml` | Compiled Actions
workflows |
| `.gitattributes` | Marks `docs/codebase/**` as `linguist-generated` |
## Test plan
- [x] `gh aw compile` produces 0 errors, 0 warnings for both workflows
- [ ] Manual trigger via `gh aw run docs-codebase-refresh` generates
initial docs
- [ ] Verify generated pages cover all integrations in `_MIN_VERSIONS`
- [ ] Push a source change to main, verify incremental workflow updates
only affected pages
- [ ] Both workflows create PRs (not direct commits)
🤖 Generated with [Claude Code](https://claude.com/claude-code)
---------
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>1 parent d93fc76 commit b3305b6
File tree
9 files changed
+3250
-0
lines changed- .github
- aw
- workflows
- docs/codebase
- _meta
9 files changed
+3250
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
0 commit comments