Commit Graph

17 Commits

Author SHA1 Message Date
Rahul Tarak 18c3b98de6 docs: reapply Algolia docs search (#3454)
## Summary
- Re-apply the Algolia docs search migration after the previous PR was
merged and reverted.
- Keep the existing Fumadocs search UI while using Algolia API when
search keys are configured, with `/api/search` fallback for local
development and tests.
- Add a first-party Algolia index builder/sync script that creates
section-sized docs records from MDX/OpenAPI/toolkit/changelog content,
configures index relevance settings, and replaces index objects without
relying on Algolia Crawler.
- Add Algolia Insights view/click events and a terminal search relevance
test script.
- Clean search breadcrumbs so results show labels like `Toolkit` and
`Cookbook` instead of duplicated `toolkits > Gmail` formatting.

## Tests
- `cd docs && bun run types:check`
- `cd docs && bun run sync:search --dry-run`
- `cd docs && bunx eslint components/custom-search-dialog.tsx
lib/search-index.ts scripts/sync-algolia-search.ts
scripts/test-algolia-search.ts`

## Notes
- Live Algolia sync requires `ALGOLIA_ADMIN_API_KEY`.
- Live search relevance tests require `ALGOLIA_SEARCH_API_KEY` or
`NEXT_PUBLIC_ALGOLIA_SEARCH_API_KEY`.
2026-05-19 02:27:40 -07:00
Rahul Tarak 5f400fc5f7 Revert "docs: migrate search to Algolia" (#3453)
Reverts ComposioHQ/composio#3452
2026-05-19 01:34:36 -07:00
Rahul Tarak 7bd3e0669c docs: migrate search to Algolia (#3452)
## Summary
- Switch docs search dialog to Algolia when public Algolia env vars are
configured, with local `/api/search` fallback for development/tests
- Add a shared docs search index builder plus `bun run sync:search` to
publish records to Algolia
- Add a GitHub Actions workflow to dry-run and sync the Algolia index on
`next` docs changes when secrets are configured
- Document required Algolia env vars and sync command

## Tests
- `cd docs && bun run types:check`
- `cd docs && bun run sync:search --dry-run`
- `cd docs && bun test tests/static/`
- `cd docs && bunx eslint components/custom-search-dialog.tsx
lib/search-index.ts scripts/sync-algolia-search.ts`
- `cd docs && bun run build`

## Notes
- `bun run lint` still fails on existing unrelated repo-wide lint errors
in files outside this change (for example `app/global-error.tsx`,
`components/ask-ai-button.tsx`, `components/version-selector.tsx`). The
changed search files pass targeted ESLint.
- Production search requires `NEXT_PUBLIC_ALGOLIA_APP_ID`,
`NEXT_PUBLIC_ALGOLIA_SEARCH_API_KEY`, and optionally
`NEXT_PUBLIC_ALGOLIA_INDEX_NAME` (default `composio_docs`). Index
syncing requires `ALGOLIA_APP_ID`/`ALGOLIA_ADMIN_API_KEY` secrets.
2026-05-19 01:33:26 -07:00
Anshu Garg 38a44abb38 docs(CLAUDE): document relative-paths rule for internal links 2026-04-21 01:58:55 +05:30
Sushmitha Mallesh b14810b3a4 docs: dual API version reference (v3.1 + v3.0) (#3179) 2026-04-11 15:26:24 -07:00
Sushmitha Mallesh 788255f030 docs: add Meta Tools reference section
Add a programmatic Meta Tools reference under Reference > Meta Tools,
powered by data fetched from the Tool Router API.

- Generator script fetches tool schemas from API, produces JSON + MDX
- CI auto-updates via docs-update-data.yml on Apollo deploys
- Individual tool pages show tags, input parameters, and response schemas
- .md endpoint renders full parameter details for LLM consumers
- Updated existing docs to include COMPOSIO_GET_TOOL_SCHEMAS

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-06 22:07:05 -08:00
Sushmitha Mallesh a7e695076d ci: fix review comments and add pipeline reference docs
- Fix checkout to use ref: next (Cursor bot high severity)
- Use prompt instead of deprecated direct_prompt (Cursor bot low severity)
- Add docs/.claude/context/pipelines.md with reference for all workflows
- Add pipelines.md to CLAUDE.md context index

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-06 17:36:37 -08:00
Sushmitha Mallesh 904228961b docs: add glossary page with filterable term definitions
Stripe-inspired two-column layout with client-side filtering.
Markdown converter handles GlossaryTerm→heading conversion for
LLM-friendly output. Added glossary link to LLM footer, search
shortcuts, and CLAUDE.md documentation.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-24 18:29:12 -08:00
Sushmitha Mallesh 8be3166ade docs: add git workflow note to CLAUDE.md (branch from next)
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-24 00:35:07 -08:00
Sushmitha Mallesh c14dc07802 docs: add Send button to chat examples, GitHub link, and review guidelines
- Add visible Send button to chat forms (page.tsx + page-with-tools.tsx)
- Add "View source on GitHub" link to chat-app cookbook
- Add code review guidelines to CLAUDE.md for tutorial code in examples/

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-23 19:22:03 -08:00
Sushmithamallesh 7026f5814a docs: add link checker and FAQ nuances to CLAUDE.md
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-18 11:50:03 -08:00
Sushmithamallesh d545254f46 docs: Add LLM guardrails system for AI code generators
Invisible instructions appended to every .md endpoint that steer AI code
generators toward the session-based pattern (composio.create + session.tools)
and provide correct direct execution patterns on tagged pages.

- Session guardrails (default): correct pattern, ALWAYS/NEVER/DISCOURAGED rules
- Direct execution guardrails: auth link flow, tool execute flow, key rules
- Frontmatter-scoped via llmGuardrails field (Zod-validated)
- llms-full.txt prepends guardrails once at top, not per-page
- 12 MDX pages tagged with llmGuardrails: "direct-execution"
- Remove dead /cookbooks path check from nav components

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-16 14:23:43 -08:00
Sushmithamallesh 9e5a3f3125 docs: disable playground and document API reference customizations
Disable the API playground (spec quality issues make it unusable).
Add documentation for all API reference customizations including
why CSS overrides are necessary (no hooks available for parameter
field indicators and content type labels).

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-04 13:15:31 -08:00
Sushmithamallesh bdac560ad1 docs: add AI-native documentation guideline
Add guidance to prefer cURL commands over UI "click" instructions
when documenting API interactions. This makes docs more useful for
AI agents that increasingly consume documentation to help users.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-02 12:45:31 -08:00
Sushmitha Mallesh 48f2698337 docs: SEO improvements - OG images, robots.txt, and CLAUDE.md restructure (#2478)
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-27 23:29:30 -08:00
Sushmithamallesh c14896e2b3 feat(docs): add page actions and fix dev memory issue
- Replace CopyPage with PageActions component (copy + view as markdown)
- Disable twoslash in dev mode to prevent heap memory issues
- Document twoslash dev/prod behavior in CLAUDE.md

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-19 14:56:11 -08:00
Sushmithamallesh a4ec83a83a chore: rename fumadocs directory to docs
- Rename fumadocs/ directory to docs/
- Update all path references in GitHub workflows
- Update CODEOWNERS
- Update SDK doc generation scripts output paths
- Rename workflow file fumadocs-check-links.yml to docs-check-links.yml
- Update package.json name to @composio/docs

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-16 12:41:58 -08:00