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, 03:37 UTC
| 1 | # Public Knowledge Base |
| 2 | |
| 3 | ## Purpose and ownership |
| 4 | |
| 5 | - The public knowledge base is hosted with the documentation at |
| 6 | `docs.composio.dev/kb`. |
| 7 | - The support portal's Front Desk is the only writer of KB guides. It writes |
| 8 | them from public information and person-approved support answers. |
| 9 | - The docs repository owns the published guides (`kb/manifest.json` for |
| 10 | topics, `kb/guides/<slug>.json`, `kb/articles`, `kb/source`), routes, search |
| 11 | integration, and presentation. `content/kb` is generated at build time and |
| 12 | not committed. |
| 13 | - The docs Ask AI agent and `/api/knowledge-search` read the same published |
| 14 | guides; there is no separate agent-only knowledge file. |
| 15 | - Product documentation remains canonical for product concepts and workflows; |
| 16 | KB guides cover support questions and troubleshooting gaps. |
| 17 | |
| 18 | ## Content boundaries |
| 19 | |
| 20 | - Only content explicitly classified for public use is eligible for import. |
| 21 | - Non-public classifications and account-specific information must never enter |
| 22 | the snapshot, generated pages, search indexes, or agent-readable outputs. |
| 23 | - New guides should address a real knowledge gap rather than duplicate an |
| 24 | existing documentation or KB page. |
| 25 | - Time-sensitive claims require an authoritative public source and current |
| 26 | verification. |
| 27 | - A source document may produce multiple focused guides. Stable slugs and |
| 28 | aliases preserve published URLs as the source evolves. |
| 29 | |
| 30 | ## Publication and maintenance |
| 31 | |
| 32 | - A proposed guide change reaches the docs repository as a `kb-guide-approved` |
| 33 | dispatch. `docs-kb-publish.yml` applies it with `scripts/publish-kb-guide.ts` |
| 34 | (create, rewrite, or retire), regenerates and validates the KB, and opens a |
| 35 | pull request on `next`. Reviewing and merging that pull request is the |
| 36 | approval; closing it dismisses the change. Nothing merges on its own. |
| 37 | - Each guide lives in its own files, so pull requests for different guides |
| 38 | can wait for review side by side without conflicting. |
| 39 | - A scheduled workflow repairs the semantic artifact when docs or guide changes |
| 40 | reached `next` without a rebuild. |
| 41 | - The ComposioHQ/support-knowledge import was retired in 2026-11; that |
| 42 | repository is no longer a source. |
| 43 | |
| 44 | ## Rendering and discovery |
| 45 | |
| 46 | - Published guides appear under `/kb` and use the docs site's existing |
| 47 | navigation, layout, feedback, and canonical-link behavior. |
| 48 | - Knowledge search covers public docs, KB guides, toolkits, examples, current |
| 49 | reference pages, and changelog entries. |
| 50 | - Search uses keyword matching first and semantic retrieval for public docs and |
| 51 | KB prose when keyword confidence is weak. |
| 52 | - Semantic-search failures fall back to public keyword results; failure must |
| 53 | never broaden the eligible corpus. |
| 54 | - Published guides are included in the sitemap and agent-readable documentation |
| 55 | outputs. |
| 56 | - Content awaiting review or marked as retired is excluded from routes and all |
| 57 | discovery surfaces. |
| 58 | |
| 59 | ## Freshness and safety |
| 60 | |
| 61 | - The manifest records each guide's sources, canonical routes, verification |
| 62 | dates, review deadlines, and publication state. |
| 63 | - Publication rejects content that is not explicitly public, contains known |
| 64 | private-data markers, has expired time-sensitive verification, has broken |
| 65 | references, or conflicts with an existing route. |
| 66 | - Time-sensitive content stays unpublished until it has been reverified. |
| 67 | - Evergreen review deadlines remain freshness-check errors for follow-up, but |
| 68 | do not block the docs build or remove previously reviewed guides. Dates are |
| 69 | extended only after review. |
| 70 | - The running docs application reads only the checked-in public guides; it |
| 71 | does not call the support portal at runtime. |
| 72 | |
| 73 | ## Failure handling |
| 74 | |
| 75 | - A candidate snapshot is validated before it replaces the current snapshot. |
| 76 | - A failed validation or import leaves the last valid public snapshot intact |
| 77 | and surfaces the failure for follow-up. |
| 78 | - Invalid or stale guides must not be silently omitted from an otherwise |
| 79 | successful publication. |
| 80 | - External-service failures may reduce search quality or link enrichment, but |
| 81 | they must not make private content eligible. |
| 82 | |
| 83 | ## Verification |
| 84 | |
| 85 | - Run `bun run test`, `bun run types:check`, `bun run lint`, |
| 86 | `bun run lint:links`, and `bun run build` from `docs/`. |
| 87 | - Verify generated KB pages and the semantic artifact are current before |
| 88 | merging a refresh. |