docs: point the SDK rules at the capability - #449
Merged
Conversation
The rules governing pkg/sdk lived in two documents addressed to people working inside osapi, while binding osapi-orchestrator, which is built on the SDK and cannot see them. CLAUDE.md drops the naming block the capability now states. guidelines.md keeps its worked examples and points at the specification for the rules they illustrate. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #449 +/- ##
=======================================
Coverage 99.94% 99.94%
=======================================
Files 484 484
Lines 24935 24935
=======================================
Hits 24921 24921
Misses 14 14 Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
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.
Implements
specify-sdk-standardstasks 2.1, 2.2, and section 3, now that osapi-io/specs#75 has merged.What moved
CLAUDE.md— the 36-lineSDK method naming (MANDATORY)block becomes a 7-line pointer. The capability states the rule; restating it here is a second copy that drifts.docs/docs/sidebar/sdk/guidelines.md— keeps every worked example, gains a note saying the rules those examples illustrate are specified in the capability, and that they bindosapi-orchestratortoo. The examples are the reason to keep the page: showing agentype leaking into a signature teaches more than the sentence forbidding it.Verification
go build ./...clean;just docusaurus-fmt-checkandjust md-fmt-checkpass.3.2 is checked by parsing each method's parameters and return types rather than grepping the file — generated types appear throughout method bodies, which is exactly what the SDK is for, and a naive grep reports those as violations.
🤖 Generated with Claude Code