Skip to content

docs: align the coding agent READMEs with the agent templates - #21

Merged
zimeg merged 3 commits into
mainfrom
clack/align-readmes-with-templates
Oct 20, 2026
Merged

zimeg merged 3 commits into
mainfrom
clack/align-readmes-with-templates

Conversation

@zimeg

@zimeg zimeg commented Oct 20, 2026 •

Copy link
Copy Markdown
Member

Summary

This pull request aligns the coding agent READMEs with the starter and support agent templates, so the shared sections read the same across samples.

  • Root README follows the agent template layout: "Choose Your Framework" with the line introducing the table and the shared-listener note under it, and "What It Can Do" as four entry points plus a paragraph on what happens in a code channel. The framework table uses the templates' compact format.
  • Intro and warning are shorter, and each framework README now opens with the same two sentences and warning as the root, after its SDK and model clause.
  • Written for people reading: App Overview step 4 and the Command approvals bullets drop tool names, examples, and internals, and the paragraphs on tool availability and requested scopes are gone. The /agent files are a bullet list.
  • Using the App in each framework README opens with "there are several ways to interact", lists App Home first like the templates, and moves the /invite step into Channel @mentions the way the templates do.
  • Testing gets the templates' comments (pytest . with the comment from the Python starter template).
  • Project Structure in the OpenAI and Pydantic AI READMEs now says guardrails.py uses the framework along with agent.py and tools, since it imports it too, matching how the Claude README already reads. All three open the guardrails.py description the same way.
  • Providers in the Pydantic AI README uses the template's wording for the note about setting at least one API key.

Framework-specific content (tools, code channel behavior, provider setup) stays as it was.

Testing

Notes

  • @mwbrooks's docs: add slack plugin install steps for coding agents #20 adds the "Claude Code, Codex, Cursor, and Other Coding Agents" section in the same root README spot, right after the framework table. Whichever lands second needs a small merge: the templates order it as table, shared-listener note, then that section, then "What It Can Do". The framework READMEs don't overlap.

🤖 Generated with Claude Code

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg zimeg added docs M-T: Documentation work only semver:patch Use on pull requests to describe the release version increment labels Oct 20, 2026
@zimeg zimeg self-assigned this Oct 20, 2026

@zimeg zimeg left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤓 Writing about changes to make. Please do make similar changes in all frameworks not just Claude SDK.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread claude-agent-sdk/README.md Outdated
Comment thread claude-agent-sdk/README.md Outdated
Comment thread claude-agent-sdk/README.md Outdated
Comment thread claude-agent-sdk/README.md Outdated
Comment thread claude-agent-sdk/README.md Outdated
Comment thread claude-agent-sdk/README.md Outdated
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg
zimeg marked this pull request as ready for review October 20, 2026 22:49
@zimeg
zimeg requested a review from a team as a code owner October 20, 2026 22:49
@zimeg

zimeg commented Oct 20, 2026

Copy link
Copy Markdown
Member Author

📚 Will merge with a matching sample adjacent for iteration onwards before the public!

@zimeg
zimeg merged commit d181040 into main Oct 20, 2026
7 checks passed
@zimeg
zimeg deleted the clack/align-readmes-with-templates branch October 20, 2026 22:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs M-T: Documentation work only semver:patch Use on pull requests to describe the release version increment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant