Introducing a new way to review your PRs.

Read the announcement

upstash / context7

Context7 Platform -- Up-to-date docs for AI agents

View on GitHub

13 documents · Updated Nov 16, 2026

docs / documentation-content

Documentation Content

Overview

This repository's documentation/content surface is a Mintlify/Docs7-style docs site plus repository-facing Markdown. The site is rooted in docs/docs.json, which sets the site identity (Context7 MCP), theme, redirects, logo/favicon paths, feedback controls, Intercom integration, navbar/footer links, and the complete navigation tree. Route slugs in docs/docs.json map directly to files under docs/ without extensions: for example overview maps to docs/overview.mdx, clients/cli maps to docs/…/cli.mdx, and enterprise/api/search/search-for-libraries maps to docs/…/search-for-libraries.mdx. The config has two top-level tabs: Context7 for product, API, client, SDK, enterprise, integration, and resource docs, and Docs7 for the documentation platform docs and MDX component reference.

The primary public Context7 docs live as MDX pages under docs/. Top-level product pages include docs/overview.mdx, docs/installation.mdx, docs/search-api.mdx, docs/api-guide.mdx, docs/plans-pricing.mdx, docs/adding-libraries.mdx, docs/library-owners.mdx, and docs/library-updates.mdx. These pages use YAML frontmatter (title, sidebarTitle, description) and Mintlify/Docs7 MDX components such as Card, CardGroup, Tabs, Tab, Steps, Step, CodeGroup, Tip, Note, Warning, Frame, Columns, and AccordionGroup. docs/installation.mdx is the only page importing shared JSX snippets from docs/…/agents.jsx; that snippet file exports inline SVG icon components for Claude, OpenAI, Cursor, and VS Code plus a StoreButton component used in the installation tabs.

Content areas are path-routable by directory. docs/…/*.mdx contains per-client setup docs for Claude Code, Codex, Copilot CLI, Cursor, OpenCode, Pi, VS Code, and the ctx7 CLI. docs/…/*.mdx covers account and library-owner workflows such as API keys, OAuth, teamspaces, policies, rules, private sources, admin MCP, verification, claiming libraries, chat widget setup, usage, and experimental tools. docs/…/*.mdx documents Context7 Ask; docs/…/overview.mdx explains the site verification tag and ask endpoint flow. docs/…/*.mdx covers third-party integrations such as GitHub Actions, CodeRabbit, Factory AI, Tembo, Mastra, and Eve. docs/…/*.mdx covers public security, privacy, infrastructure, compliance, data-safety, and access-control explanations.

Enterprise on-premise documentation is grouped under docs/enterprise/. docs/…/on-premise.mdx is the main getting-started page and explains deployment, AI/embedding provider configuration, local state, private repository ingestion, MCP connection, and network/data flow. Subdirectories under docs/enterprise/ separate on-premise concerns: deployment/ for Docker, Kubernetes, Helm, scaling, and vector stores; integrations/ for GitHub, other Git providers, Gerrit, Confluence, Google Drive, Notion, and AWS Bedrock; security/ for SSO and library access; enterprise-managed-auth/ for Entra and Okta enterprise-managed authorization; and api/ for generated API-reference pages. The enterprise API pages are deliberately thin MDX wrappers with openapi: frontmatter that points at docs/openapi-enterprise.json, such as docs/…/search-for-libraries.mdx with openapi: "openapi-enterprise.json GET /v2/libs/search" and parse/context wrappers under docs/enterprise/api/parse/ and docs/enterprise/api/context/.

docs/openapi-enterprise.json is the local OpenAPI source for the on-premise API reference. It describes the Context7 On-Premise API, has servers for a replaceable deployed host and local development, and defines paths including /v2/libs/search, /v2/context, /parse, /parse-openapi, /parse-openapi-upload, /parse-website, /projects/{projectId}/refresh, /parse-status, and /import-libraries. Public cloud API docs are split between prose in docs/api-guide.mdx and docs/search-api.mdx and a remote OpenAPI group in docs/docs.json (openapi: "https://context7.com/openapi.json") rather than a checked-in public OpenAPI file.

The Docs7 product documentation lives under docs/docs7/. docs/…/overview.mdx introduces Docs7 as a documentation platform for humans and agents, with quickstart, plans, configuration, custom-domains, migrate-from-mintlify, builds, analytics, ai-visibility, agent, feature-requests, seo, agent-readiness, and cli pages under the same directory. docs/…/*.mdx is the MDX component reference for built-in docs components; docs/…/react-components.mdx also documents small inline MDX component exports and recommends shared MDX or JSX snippets for repeated components.

Images and static assets are split by serving context. docs/public/ contains assets referenced by the docs-site config: docs/…/logo.svg, docs/…/logo-dark.svg, docs/…/logo.png, and docs/public/favicon.ico; these are used by the logo and favicon fields in docs/docs.json. docs/images/ contains docs-page images organized by feature area (ask/, clients/, dashboard/, docs7/, enterprise/, howto/, integrations/, security/) plus top-level architecture/scaling images such as docs/…/on-premise-architecture.png, docs/…/scaling-settings.png, and docs/…/scaling-multi-replica.png. MDX pages reference these images with absolute docs-site paths like /images/on-premise-architecture.png or images/…/01-register-app.png. docs/…/README.md is a capture checklist for the Entra SSO screenshot set and is documentation for maintaining the images rather than a rendered route.

The repository root README and localized READMEs are separate from the docs site. README.md is the GitHub landing page: it uses public/cover.png, links to the localized files in i18n/README.*.md, explains Context7's CLI + Skills and MCP modes, documents npx ctx7 setup, lists CLI/MCP tools, links to the hosted docs pages, lists npm packages, and includes a disclaimer that this repository contains the MCP server source while the API backend, parsing engine, and crawling engine are private. i18n/ contains translated README variants for Arabic, German, Spanish, French, Indonesian, Italian, Japanese, Korean, Brazilian Portuguese, Russian, Turkish, Ukrainian, Vietnamese, Simplified Chinese, and Traditional Chinese. These localized READMEs follow the same repository-facing purpose as README.md but are not generated from docs/docs.json; they can drift from the current English README and must be maintained explicitly.

Root-level public/ contains GitHub/package-facing media rather than docs-site assets: public/cover.png is embedded by README.md, and public/context7-logo.svg, public/context7-icon.svg, public/context7-icon-green.svg, and public/icon.png provide general project branding. SECURITY.md defines the repository security policy, supported Context7 MCP version line, vulnerability reporting channels, and response expectations. LICENSE is the MIT license for the repository.

Coupling

  • If a page is added, removed, or renamed under docs/, update docs/docs.json in the same change when it should appear in navigation or when old URLs need redirects. The docs router uses extensionless page slugs from docs/docs.json, so a moved file such as docs/…/cursor.mdx must be reflected as clients/cursor or linked routes will break.
  • If docs/openapi-enterprise.json changes an operation path or method, update the openapi: frontmatter wrappers under docs/enterprise/api/**. Those MDX files contain little more than frontmatter, so stale operation strings silently point the rendered API reference at the wrong or missing operation.
  • If docs/…/agents.jsx changes exported names or JSX component props, verify docs/installation.mdx. It imports ClaudeIcon, CursorIcon, OpenAIIcon, StoreButton, and VSCodeIcon directly from /snippets/agents.jsx; renaming or changing those exports will break the installation page rendering.
  • If docs/docs.json changes logo.light, logo.dark, or favicon, verify the referenced files under docs/public/. Conversely, moving files under docs/public/logo/ or docs/public/favicon.ico requires updating those config paths because they are not the same assets as root public/.
  • If an image under docs/images/ is renamed or deleted, search the owning MDX page for the absolute /images/... reference and update it in the same change. The image paths are hard-coded in content pages such as docs/…/on-premise.mdx, docs/…/*.mdx, docs/…/*.mdx, docs/…/*.mdx, and docs/…/*.mdx.
  • If README.md changes installation commands, Node.js requirements, tool names, package names, or public docs links, consider whether the localized files in i18n/README.*.md need equivalent updates. They are independent Markdown files and are not automatically synchronized with the English README.
  • If root public/cover.png or other root branding assets change, verify README.md and package/marketplace consumers rather than docs/docs.json; the docs site uses docs/public/ for logo and favicon assets.

Risks

  • docs/docs.json is the single navigation and route registry for the docs site. If a file is renamed under docs/ without updating its extensionless slug in this file, the page may still exist in the repository but disappear from navigation or produce a broken docs route.
  • docs/…/*.mdx depends on exact operation identifiers in docs/openapi-enterprise.json. If an OpenAPI path is changed but the wrapper frontmatter is not, the generated API reference for on-premise users can show no operation or the wrong operation.
  • i18n/README.*.md can become stale relative to README.md because the localized READMEs are full copies, not generated translations. Inconsistencies are especially risky for setup commands and runtime prerequisites; for example README.md currently states that ctx7 requires Node.js 22.13 or newer, while localized files may carry older installation text.