refactor(sdk-skill-creator): move philosophy doc into skill references

Move docs/sdk-skill-philosophy.md into
skills/sentry-sdk-skill-creator/references/philosophy.md so the SDK skill
authoring guide lives alongside the skill that implements it, rather than
in a separate top-level docs directory.

Updated all references across AGENTS.md, README.md, SKILL.md, and
.pi/context.md to point to the new location. Removed the now-empty docs/
directory. Fixed a commit-strategy list numbering gap in SKILL.md caused
by removing the obsolete philosophy-doc commit step.
This commit is contained in:
Daniel Griesser
2026-02-28 13:03:41 +01:00
parent 01b71b5d7e
commit 4d235fa92c
4 changed files with 9 additions and 10 deletions
+1 -1
View File
@@ -197,7 +197,7 @@ Configure Sentry features in a project. Pattern:
Full SDK setup wizards that scan the project, make opinionated feature recommendations, and guide through setup of error monitoring, tracing, profiling, logging, and more. Each bundle is a directory with a main `SKILL.md` wizard and `references/` deep-dive files loaded conditionally.
See **[docs/sdk-skill-philosophy.md](docs/sdk-skill-philosophy.md)** for the complete authoring guide: bundle architecture, wizard flow, reference file format, and naming conventions.
See **[skills/sentry-sdk-skill-creator/references/philosophy.md](skills/sentry-sdk-skill-creator/references/philosophy.md)** for the complete authoring guide: bundle architecture, wizard flow, reference file format, and naming conventions.
### Workflow Skills
+1 -1
View File
@@ -424,7 +424,7 @@ Contributions are welcome! Please ensure any new skills:
4. Include an "Invoke This Skill When" section with trigger phrases
6. Verify technical details against [Sentry docs](https://docs.sentry.io/)
For full-platform SDK skills (covering all Sentry features for one language/framework), see [docs/sdk-skill-philosophy.md](docs/sdk-skill-philosophy.md) for the bundle architecture pattern.
For full-platform SDK skills (covering all Sentry features for one language/framework), see [skills/sentry-sdk-skill-creator/references/philosophy.md](skills/sentry-sdk-skill-creator/references/philosophy.md) for the bundle architecture pattern.
### Style Guidelines
+6 -7
View File
@@ -15,7 +15,7 @@ Produce a complete, research-backed SDK skill bundle — a main wizard SKILL.md
- Building a new `sentry-<platform>-sdk` skill bundle
- Porting the SDK skill pattern to a new Sentry SDK
> Read `${SKILL_ROOT}/../../docs/sdk-skill-philosophy.md` first — it defines the bundle architecture, wizard flow, and design principles this skill implements.
> Read `${SKILL_ROOT}/references/philosophy.md` first — it defines the bundle architecture, wizard flow, and design principles this skill implements.
---
@@ -182,7 +182,7 @@ license: Apache-2.0
### Key Principles for the Main SKILL.md
1. **Keep it lean** — deep details go in references, not here
2. **Wizard-first for framework SDKs** — if the Sentry wizard supports this framework, present it as "Option 1: Wizard (Recommended)" before any manual setup. The wizard handles the full auth flow (login, org/project selection, auth token creation), source map upload, build tool plugins, and framework-specific wiring — all in one interactive step. See the [philosophy doc](../../docs/sdk-skill-philosophy.md) for the full pattern.
2. **Wizard-first for framework SDKs** — if the Sentry wizard supports this framework, present it as "Option 1: Wizard (Recommended)" before any manual setup. The wizard handles the full auth flow (login, org/project selection, auth token creation), source map upload, build tool plugins, and framework-specific wiring — all in one interactive step. See `${SKILL_ROOT}/references/philosophy.md` for the full pattern.
3. **Source maps are non-negotiable for frontend/mobile** — the manual setup path must include source map upload configuration (build tool plugin + env vars). Without source maps, production stack traces are unreadable minified code.
4. **Detection commands must be real** — test them against actual projects
5. **Recommendation logic must be opinionated** — "always", "when X detected", not "maybe consider"
@@ -295,11 +295,10 @@ After the skill passes review:
### Commit Strategy
Each major piece gets its own commit:
1. `docs: add sdk-skill-philosophy reference` (if new)
2. `feat(<platform>-sdk): add sentry-<platform>-sdk main SKILL.md wizard`
3. `feat(<platform>-sdk): add reference deep-dives for all feature pillars`
4. `docs(readme): add sentry-<platform>-sdk to available skills`
5. `fix(skills): address review findings` (if any)
1. `feat(<platform>-sdk): add sentry-<platform>-sdk main SKILL.md wizard`
2. `feat(<platform>-sdk): add reference deep-dives for all feature pillars`
3. `docs(readme): add sentry-<platform>-sdk to available skills`
4. `fix(skills): address review findings` (if any)
---
@@ -333,6 +333,6 @@ Opinionated wizard that scans your project and guides you through complete Sentr
## See Also
- [AGENTS.md](../AGENTS.md) — General skill authoring guidelines and style rules
- [AGENTS.md](../../../AGENTS.md) — General skill authoring guidelines and style rules
- [Agent Skills Specification](https://agentskills.io/specification)
- [Sentry Documentation](https://docs.sentry.io/)