Draft or revise technical documentation in a direct, friendly style based on Modal's documentation. Lead with the concept or benefit, place a runnable example near the top, and reduce jargon and vague promotional wording.
Writing style guide derived from Modal's documentation voice. Apply when writing or editing docs, guides, tutorials, or technical prose that should read direct, second-person, confident, low-jargon, and example-first. Use to draft new docs in this voice or to revise existing prose toward it.
Review the instructions the agent will receive before you install.
Write docs the way Modal writes them: direct, friendly, confident, and ruthlessly practical. Explain the why in one breath, then show working code. Treat the reader as a capable developer who wants to ship, not a student who needs a lecture.
Read references/style-guide.md for the full rule set (Voice, Structure, Terminology, Punctuation, Code examples, Formatting) and apply every rule while drafting.
The rules that matter most, before you open the reference:
To review existing prose against these rules instead of drafting, use good-docs-audit.
No reviews yet. Tell others what you thought.
No login needed. Share how it worked for you, ask a question, or note where it did not run.
No comments yet. Be the first to write one.
Fix defects in Composio SDK through focused reproduction, root-cause analysis, regression tests that check for recurrence, and targeted verification. Use it for reported bugs, failing tests, CI regressions, runtime errors, or incorrect SDK behavior.
Design, implement, and review Composio CLI commands, including user interactions, output, errors, and configuration. It guides command wiring and service changes using Effect and effect/cli, with references for implementation patterns.
Create, update, and debug Docker-based end-to-end tests for the Composio CLI. Covers running the executable, keeping test data separate, checking command output, and maintaining package manifests within the CLI test suite.
Build beta versions of the Composio CLI, promote a tested beta to a stable release, and investigate failed releases. Guides verification of published binaries and installation tests through the Build CLI Binaries workflow.
Set up and use Composio to connect AI agents with apps such as Gmail, Slack, and Notion. Selects guidance for personal accounts or product integrations, covering setup, app operations, troubleshooting, and migration.
Keep TypeScript and Python SDKs consistent when shared behavior or backend APIs change. Aligns public API names, use of generated clients, and documentation examples, including updates to the fixed versions of generated clients.