@devries-cameron20 / composio Mirror · read-only
Fork 0

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

Mirrored from https://github.com/Camo67/composio.git

Synced Nov 21, 06:00 UTC

next
md 54 lines 4.26 KB
Rendered Raw
1 # Changelog → Docs Updater
2
3 Analyzes new changelog entries and updates documentation to reflect the changes.
4
5 ## When This Runs
6
7 Triggered when a changelog file (`docs/content/changelog/*.mdx`) is pushed to `next`. Creates a PR with suggested documentation updates.
8
9 ## Process
10
11 1. Read each new/modified changelog file
12 2. Categorize the changes (breaking change, new feature, deprecation, bug fix, behavior change)
13 3. For each change, search `docs/content/docs/` for pages that reference the affected feature
14 4. Make targeted documentation updates
15
16 ## What to Update
17
18 | Changelog Type | Docs Action |
19 | ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------- |
20 | **Breaking change** (new API signature, removed parameter) | Update code examples in affected guides to use the new API |
21 | **New feature** (new parameter, new method, new option) | Add to the relevant existing guide where it fits naturally |
22 | **Deprecation** | Add a `<Callout type="warn">` note near the deprecated usage |
23 | **Behavior change** (default changed, response format changed) | Update descriptions and examples that reference the old behavior |
24 | **Toolkit changes** (new toolkit, toolkit deprecation, credential removal, toolkit-level config) | No docs changes needed (toolkit pages are auto-generated) |
25 | **Bug fix** (no API change) | No docs changes needed |
26 | **Performance improvement** | No docs changes needed |
27 | **Infrastructure / internal changes** | No docs changes needed |
28
29 ## Rules
30
31 - Only modify files in `docs/content/docs/` and `docs/content/examples/`
32 - Do NOT create new pages — only update existing ones
33 - Do NOT add changelog-style content ("as of v0.6.0...") to docs. Docs should describe current behavior.
34 - Do NOT make cosmetic or stylistic changes unrelated to the changelog
35 - Follow existing patterns in the docs (Tabs for Python/TypeScript, `<Callout>` for warnings)
36 - TypeScript code blocks in MDX are type-checked at build time. Add proper imports above `// ---cut---` lines. See `docs/agent-guidance/context/twoslash.md` for details.
37 - If no documentation changes are needed, make no file changes
38
39 ## Key Docs Pages
40
41 These are the most commonly affected pages. Search broadly, but start here:
42
43 | Topic | Docs Page |
44 | ------------------- | --------------------------------------------------------------------------------------- |
45 | Sessions API | `configuring-sessions.mdx` |
46 | Authentication | `authentication.mdx`, `authenticating-users/` |
47 | Tools & toolkits | `tools-and-toolkits.mdx`, `tools-direct/` |
48 | Triggers & webhooks | `triggers.mdx`, `webhook-verification.mdx`, `setting-up-triggers/` |
49 | Connected accounts | `managing-multiple-connected-accounts.mdx`, `auth-configuration/connected-accounts.mdx` |
50 | Auth configs | `using-custom-auth-configuration.mdx`, `auth-configuration/` |
51 | White labeling | `white-labeling-authentication.mdx` |
52 | Migration | `migration-guide/` |
53 | SDK quickstart | `quickstart.mdx` |
54 | Providers | `providers/` |