mirror of
https://github.com/ComposioHQ/composio.git
synced 2026-09-22 11:46:35 +08:00
Alberto Schiabel
7fe998c45c
## Summary Documents session deletion (`session.delete()`) and realigns the docs site's `@composio/*` dependencies so the new snippet type-checks against a published SDK. ## Changes - **`docs/content/docs/configuring-sessions.mdx`** — adds a `### delete()` section with Python and TypeScript examples and a version-requirement callout (`@composio/core` ≥ `0.13.1` / `composio` ≥ `0.17.1`). - **`docs/package.json` + `docs/bun.lock`** — bumps `@composio/core` `^0.9.1` → `^0.13.1` (the release that adds `delete()`) and aligns the provider packages to their `^0.10.x`/`^0.11.0` releases (peer `@composio/core >=0.10.0 <1.0.0`). ## Why the dependency bump The docs site type-checks every Twoslash snippet against the `@composio/*` versions pinned in `docs/package.json`. Those pins were stale (`@composio/core@0.9.1`), and `delete()` only exists on the `Session` type from `0.13.1`, so the snippet didn't compile. The original sync run worked around this with a `DeletableSession` cast; this PR fixes the root cause by bumping the pins to published releases that expose `delete()` natively and dropping the cast. The full docs build (Twoslash validation) passes against the bump. ## Review checklist - [ ] `delete()` examples accurately reflect the SDK behavior - [ ] Version callout matches the releases that introduce `delete()` - [ ] No unrelated docs were modified ## Notes - Originally produced by the `Docs - Sync guides on SDK changes` run. - Follow-up https://github.com/ComposioHQ/composio/pull/3709 prevents this pin drift from recurring by realigning the docs `@composio/*` deps automatically on each SDK sync. --------- Co-authored-by: jkomyno <12381818+jkomyno@users.noreply.github.com>
Composio Docs
Documentation site for Composio, built with Fumadocs.
Getting Started
bun install
bun run dev
Open http://localhost:3000.
Project Structure
docs/
├── app/ # Next.js app router
├── content/ # MDX content
│ ├── docs/
│ ├── examples/
│ ├── changelog/
│ └── reference/
├── components/ # React components
├── lib/ # Utilities
└── public/ # Static assets
Adding Content
Create an .mdx file in content/, add frontmatter, then add to meta.json:
---
title: Page Title
description: Brief description
---
Content here...
Components
<Tabs items={['Python', 'TypeScript']}>
<Tab value="Python">...</Tab>
<Tab value="TypeScript">...</Tab>
</Tabs>
<Callout type="info">Note</Callout>
<Cards>
<Card title="Title" href="/path" />
</Cards>
Sidebar
Each folder has meta.json for ordering:
{
"pages": ["page-one", "page-two"]
}
TypeScript Code Blocks
All TypeScript code blocks in MDX files are type-checked at build time using Twoslash. This ensures docs stay in sync with the SDK.
- Use
// @noErrorsto skip checking for partial snippets - Use
// ---cut---to hide setup code from output - Run
bun run buildlocally to validate before pushing
See CLAUDE.md for detailed patterns and troubleshooting.
Search
Docs search uses Algolia when NEXT_PUBLIC_ALGOLIA_SEARCH_API_KEY is set; otherwise it falls back to the local Fumadocs /api/search endpoint for development and tests. The sync script builds a first-party index from MDX/OpenAPI/toolkit data (no crawler required), splits long pages into section-sized records, configures searchable attributes/custom ranking/distinct, requests clickAnalytics, and sends search result view/click events with search-insights.
NEXT_PUBLIC_ALGOLIA_APP_ID=62HI9PQZ1L # optional; default shown
NEXT_PUBLIC_ALGOLIA_SEARCH_API_KEY=...
NEXT_PUBLIC_ALGOLIA_INDEX_NAME=docs_composio # optional; default shown
Sync the Algolia index with an admin key:
ALGOLIA_APP_ID=62HI9PQZ1L
ALGOLIA_ADMIN_API_KEY=...
ALGOLIA_INDEX_NAME=docs_composio bun run sync:search
Preview the generated records or test live relevance:
bun run sync:search --dry-run --samples
ALGOLIA_SEARCH_API_KEY=... bun run test:search "oauth auth config" "gmail send email"
Commands
| Command | Description |
|---|---|
bun run dev |
Dev server |
bun run build |
Production build (validates TS code blocks) |
bun run types:check |
Type check |
bun run sync:search |
Sync docs search records to Algolia |
bun run test:search |
Query the configured Algolia index from the terminal |