docs-decisions

Guides documentation workflows and ADR-style decision records for the Composio docs site.

30.0k|4.8k|Updated Feb 23, 2024
One-click install
npx skills add https://github.com/ComposioHQ/composio --skill docs-decisions
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-decisions
Source: https://github.com/ComposioHQ/composio/tree/main/.agents/skills/docs-decisions
Command: npx skills add https://github.com/ComposioHQ/composio --skill docs-decisions

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Maintaining consistent documentation and recording durable docs decisions is hard when content, changelogs, and automation prompts span many files. This Skill provides the workflow rules and decision-record conventions needed to edit the Composio docs site correctly.

Core Features & Use Cases

  • Docs Workflow Guidance: Covers docs commands (build, lint, link checks, generators), content rules, and automation prompt maintenance for the Fumadocs-based docs site.
  • Decision Records: Provides a template and update process for ADR-style records stored in docs/decisions/, including style rules and index maintenance.
  • Use Case: When a docs change alters an accepted direction, use this Skill to patch the existing decision record, update docs/decisions/README.md, and verify links with the lint:links command.

Quick Start

Use the docs-decisions skill to record a new docs decision about changelog formatting and update the decisions index.

Frequently Asked Questions about docs-decisions

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I record a documentation decision in the Composio repo?

Create a lowercase, descriptively named Markdown file in docs/decisions/ using the decision template: state the decision first, then context, consequences, and verification steps. Register every new record in docs/decisions/README.md.

What commands validate docs changes before submitting a PR?

Run bun run build, types:check, lint, lint:links, and test from the docs/ directory. Branch docs work from next and target PRs at next, and use lint:links whenever content links changed.

When should I update an existing decision record instead of creating a new one?

Update an existing record when a docs change alters an accepted decision. Read the current record, patch the decision or add a dated note, update the decisions index, and verify links with bun run lint:links.

Can I use this skill for SDK runtime code changes?

No. This skill is scoped to documentation work where docs are the main deliverable, including docs content, Fumadocs configuration, changelogs, and automation prompts. SDK runtime changes fall outside its scope.

What are the content rules for Composio documentation?

Use relative site links instead of absolute URLs, prefer cURL for API examples, and change generated OpenAPI, toolkit, and meta-tool data only through their scripts. TypeScript code blocks are type-checked by the docs build via Twoslash.