Template: a procedure-first README and the full qualification list - #19
Merged
Merged
Conversation
The README opens with the five steps from copy to gated (copy, rename in .osp/, delete the examples, validate and render, what the gate runs on every pull request), links Tutorial 3 and the package authoring guide instead of explaining .osp/ at length, lists the layout with evals/README.md and the release qualification workflow, runs the golden notebook rule through uv, and ends with the skeleton sections every capability README keeps, with placeholders and the rendered runtime table. The qualification requirements gain connector-invocation and side-effect-confirmation; the knowledge index declares dependencies in .osp/package.yaml; CONNECTORS.md and the eval pointers cite docs/runtime-distribution.md and docs/testing.md instead of the retired guides. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DVKYxSeRJWncZVsmaxC4p4 Signed-off-by: Paul M Ramirez <145389399+PaulMRamirez@users.noreply.github.com>
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.
Pull request
What and why
Part of the organization-wide documentation restructure. The README is now the README a copier will ship: a five-step procedure on top (copy, rename repository.name and the package name, delete the examples, validate and render, what the gate runs), then the skeleton sections with placeholders and the rendered runtime block untouched; it links Tutorial 3 and the package authoring guide instead of explaining .osp at length; rule 3 uses uv run. surfaces.yaml requires the full eleven-test list (connector-invocation and side-effect-confirmation were missing, so a copied capability never qualified its connector or its gate). knowledge/index.md says dependencies are declared in .osp/package.yaml. CONNECTORS.md and the evals docs point at the marketplace testing guide and runtime-distribution.md. The schema's kind enum has no "domain", so the README says kind: capability. validate, render --check, plugin-check, advertise --check, the OKF checker, the prose check and the script-dependency check pass.
Checklist
git commit -s)commands/directories anywhere (everything is a skill)~/.netrccontents anywhere in the diffReviews
Ordinary PR, one maintainer review.
🤖 Generated with Claude Code
https://claude.ai/code/session_01DVKYxSeRJWncZVsmaxC4p4
Generated by Claude Code