Skip to content

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

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

zimeg merged 4 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' # Run unit tests comment, and the blank line before </details> under "Starting the app" comes back.
  • Project Structure in the OpenAI README now says guardrails.js uses the OpenAI Agents SDK along with agent.js and tools, since it imports it too, matching how the Claude README already reads. Both open the guardrails.js description the same way.

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

Testing

  • Open each README on this branch and confirm the headings, tables, and <details> sections render.
  • Compare a framework README with its starter agent template, like bolt-js-starter-agent/openai-agents-sdk/README.md, and confirm the shared sections match.

Notes

  • @mwbrooks's docs: add slack plugin install steps for coding agents #6 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
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg

zimeg commented Oct 20, 2026

Copy link
Copy Markdown
Member Author

🤖 Mirrors the review on bolt-python-coding-agent#21 in 1ca56fe: the root intro and warning, no duplicate Using the App or Local Development in the root, framework intros that match the root, a generic step 4, shorter Command approvals bullets, no tool-availability or scopes paragraphs, and /agent as bullets. JS keeps its one Windows note about .cmd and .bat programs.

zimeg and others added 2 commits October 20, 2026 15:42
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:50
@zimeg

zimeg commented Oct 20, 2026

Copy link
Copy Markdown
Member Author

🗣️ Iterations from adjacent slack-samples/bolt-python-coding-agent#21 have landed here so I'll merge this now.

@zimeg
zimeg merged commit 7828662 into main Oct 20, 2026
5 checks passed
@zimeg
zimeg deleted the clack/align-readmes-with-templates branch October 20, 2026 22:51
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