Skip to content

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

docs: group launch guides under Production readiness

Brendan O'Learye4a05d2f4558
diff --git a/docs/content/docs/authentication/meta.json b/docs/content/docs/authentication/meta.json
index f722666d1..5a6229190 100644
--- a/docs/content/docs/authentication/meta.json
+++ b/docs/content/docs/authentication/meta.json
@@ -4,7 +4,6 @@
"manually-authenticating",
"managing-multiple-connected-accounts",
"importing-existing-connections",
- "custom-app-vs-managed-app",
"programmatic-auth-configs",
"controlling-scopes",
"white-labeling-authentication"
diff --git a/docs/content/docs/poc-to-prod/meta.json b/docs/content/docs/poc-to-prod/meta.json
index 8246a4767..2ffe66c0c 100644
--- a/docs/content/docs/poc-to-prod/meta.json
+++ b/docs/content/docs/poc-to-prod/meta.json
@@ -1,4 +1,9 @@
{
- "title": "POC to prod",
- "pages": ["stream-logs-to-a-siem"]
+ "title": "Production readiness",
+ "pages": [
+ "../authentication/custom-app-vs-managed-app",
+ "[Rate limits](/reference/rate-limits)",
+ "../security/data-retention",
+ "stream-logs-to-a-siem"
+ ]
}
diff --git a/docs/content/docs/security/meta.json b/docs/content/docs/security/meta.json
index 8e6c17211..7e6011ebf 100644
--- a/docs/content/docs/security/meta.json
+++ b/docs/content/docs/security/meta.json
@@ -2,7 +2,6 @@
"title": "Security and data",
"defaultOpen": false,
"pages": [
- "overview",
- "data-retention"
+ "overview"
]
}
diff --git a/docs/content/reference/meta.json b/docs/content/reference/meta.json
index bce8fc3bb..ac0c38ecb 100644
--- a/docs/content/reference/meta.json
+++ b/docs/content/reference/meta.json
@@ -3,7 +3,6 @@
"pages": [
"index",
"authenticating-to-composio",
- "rate-limits",
"errors",
"glossary",
"api-reference",
diff --git a/docs/lib/home-navigation.ts b/docs/lib/home-navigation.ts
index b6db2b87f..321360a65 100644
--- a/docs/lib/home-navigation.ts
+++ b/docs/lib/home-navigation.ts
@@ -123,6 +123,7 @@ export const DOCS_PRODUCTS = {
'/docs/extending-sessions',
'/docs/setting-up-triggers',
'/docs/poc-to-prod',
+ '/docs/security/data-retention',
'/docs/sessions-vs-direct-execution',
'/docs/tools-direct',
'/docs/auth-configuration',
@@ -238,7 +239,10 @@ export function docsProductDestination(pathname: string, target: DocsProduct): s
const sourceProduct = target === 'platform' ? 'for-you' : 'platform';
const counterpart = PRODUCT_COUNTERPARTS.find(pair => matchesRoute(pathname, pair[sourceProduct]));
if (counterpart) return counterpart[target];
- if (SHARED_ROUTE_PREFIXES.some(prefix => matchesRoute(pathname, prefix))) return pathname;
+ if (
+ classifyDocsProduct(pathname) !== sourceProduct &&
+ SHARED_ROUTE_PREFIXES.some(prefix => matchesRoute(pathname, prefix))
+ ) return pathname;
return DOCS_PRODUCTS[target].landingRoute;
}
diff --git a/docs/tests/static/navigation.test.ts b/docs/tests/static/navigation.test.ts
index 00328a13f..09d257fb9 100644
--- a/docs/tests/static/navigation.test.ts
+++ b/docs/tests/static/navigation.test.ts
@@ -136,6 +136,15 @@ describe("Navigation - meta.json validity", () => {
// Handle "..." (rest) entries which are valid fumadocs syntax
if (entry === "...") continue;
+ const link = entry.match(/^\[[^\]]+\]\((\/[^)]+)\)$/);
+ if (link) {
+ const target = join(CONTENT_DIR, '..', link[1].slice(1));
+ if (!await exists(`${target}.mdx`) && !await exists(join(target, 'index.mdx'))) {
+ errors.push(`${relDir}/meta.json → "${entry}" (link target not found)`);
+ }
+ continue;
+ }
+
const asFile = join(dir, `${entry}.mdx`);
const asDir = join(dir, entry);
diff --git a/docs/tests/static/product-navigation.test.ts b/docs/tests/static/product-navigation.test.ts
index aedbd71ad..9e5652c6a 100644
--- a/docs/tests/static/product-navigation.test.ts
+++ b/docs/tests/static/product-navigation.test.ts
@@ -11,7 +11,7 @@ import {
shouldAnimateDocsProductSwitch,
} from '../../lib/home-navigation';
import { buildProductPageTree, pageTreeUrls } from '../../lib/product-page-tree';
-import { source } from '../../lib/source';
+import { referenceSource, source } from '../../lib/source';
describe('Docs product navigation', () => {
test('defines the product labels, descriptions, landings, and themes once', () => {
@@ -39,6 +39,7 @@ describe('Docs product navigation', () => {
expect(classifyDocsProduct('/docs/authentication/controlling-scopes')).toBe('platform');
expect(classifyDocsProduct('/docs')).toBeNull();
expect(classifyDocsProduct('/docs/security/overview')).toBeNull();
+ expect(classifyDocsProduct('/docs/security/data-retention')).toBe('platform');
});
test('uses route inference before persistence and the documented default last', () => {
@@ -77,6 +78,9 @@ describe('Docs product navigation', () => {
expect(docsProductDestination('/docs/security/data-retention', 'platform')).toBe(
'/docs/security/data-retention',
);
+ expect(docsProductDestination('/docs/security/data-retention', 'for-you')).toBe(
+ '/docs/agent-plugins',
+ );
});
test('animates only when view transitions are available and motion is allowed', () => {
@@ -126,11 +130,30 @@ describe('Docs product navigation', () => {
expect(forYouUrls).not.toContain('/docs');
expect(platformUrls).not.toContain('/docs');
- for (const sharedUrl of ['/docs/security/overview', '/docs/security/data-retention']) {
+ for (const sharedUrl of ['/docs/security/overview']) {
expect(forYouUrls).toContain(sharedUrl);
expect(platformUrls).toContain(sharedUrl);
}
+ const readiness = platformTree.children.flatMap(node =>
+ node.type === 'folder' ? [node, ...node.children] : [node],
+ ).find(node => node.type === 'folder' && node.name === 'Production readiness');
+ expect(readiness?.type).toBe('folder');
+ if (readiness?.type !== 'folder') throw new Error('Production readiness folder missing');
+ const readinessUrls = readiness.children.flatMap(node => node.type === 'page' ? [node.url] : []);
+ expect(readinessUrls).toEqual([
+ '/docs/authentication/custom-app-vs-managed-app',
+ '/reference/rate-limits',
+ '/docs/security/data-retention',
+ '/docs/poc-to-prod/stream-logs-to-a-siem',
+ ]);
+ for (const url of readinessUrls) {
+ expect(platformUrls.filter(candidate => candidate === url)).toHaveLength(1);
+ expect(forYouUrls).not.toContain(url);
+ }
+ expect(pageTreeUrls(referenceSource.pageTree)).not.toContain('/reference/rate-limits');
+ expect(referenceSource.getPage(['rate-limits'])?.url).toBe('/reference/rate-limits');
+
const coveredUrls = new Set([...forYouUrls, ...platformUrls]);
const excludedUrls = new Set(['/docs']);
const omittedUrls = pageTreeUrls(source.pageTree).filter(
diff --git a/docs/tests/static/start-routing.test.ts b/docs/tests/static/start-routing.test.ts
index 4f1df3019..02a0a6708 100644
--- a/docs/tests/static/start-routing.test.ts
+++ b/docs/tests/static/start-routing.test.ts
@@ -5,8 +5,8 @@ import { HOME_INTENTS } from '../../lib/home-navigation';
const read = (path: string) => Bun.file(new URL(`../../${path}`, import.meta.url)).text();
/**
- * The 7 auth guides live in the Authentication folder; shared connections is a
- * session capability and lives under Extend sessions.
+ * Auth guides retain their URLs; managed vs custom auth is listed under
+ * Production readiness. Shared connections lives under Extend sessions.
*/
const AUTH_GUIDES = [
'manually-authenticating',
@@ -52,17 +52,23 @@ describe('getting-started routing policy', () => {
});
test('keeps progressive authentication guides in the human hub and the sidebar', async () => {
- const [authentication, authMeta, sessionsMeta] = await Promise.all([
+ const [authentication, authMeta, sessionsMeta, readinessMeta] = await Promise.all([
read('content/docs/authentication/index.mdx'),
read('content/docs/authentication/meta.json'),
read('content/docs/extending-sessions/meta.json'),
+ read('content/docs/poc-to-prod/meta.json'),
]);
const authPages = JSON.parse(authMeta).pages as string[];
const sessionPages = JSON.parse(sessionsMeta).pages as string[];
for (const guide of AUTH_GUIDES) {
expect(authentication).toContain(`href="/docs/authentication/${guide}"`);
- expect(authPages).toContain(guide);
+ if (guide === 'custom-app-vs-managed-app') {
+ expect(authPages).not.toContain(guide);
+ expect(JSON.parse(readinessMeta).pages).toContain(`../authentication/${guide}`);
+ } else {
+ expect(authPages).toContain(guide);
+ }
}
expect(authentication).toContain('href="/docs/extending-sessions/shared-connections"');
@@ -108,8 +114,8 @@ describe('getting-started routing policy', () => {
for (const guide of AUTH_GUIDES) {
expect(sectionOf(`/docs/authentication/${guide}`)).toEqual({
- section: '## Core concepts',
- nearest: '### Authentication',
+ section: guide === 'custom-app-vs-managed-app' ? '## Guides' : '## Core concepts',
+ nearest: guide === 'custom-app-vs-managed-app' ? '### Production readiness' : '### Authentication',
});
}