Commit Graph

65 Commits

Author SHA1 Message Date
Fahreddin Özcan d27c0f1bf8 docs: add eve integration guide (#3038) 2026-08-15 17:42:43 +03:00
Fahreddin Özcan 0e3298e643 docs: add Gerrit integration guide (#3035)
* docs: add Gerrit integration guide

* docs: clarify Gerrit host configuration

* docs: add Gerrit setup screenshots
2026-08-14 15:23:20 +03:00
Fahreddin Özcan 80f9d6cfa1 docs(enterprise): add library access control page (#2928)
* docs(enterprise): add library access control page

* docs(enterprise): document central library access management

* docs(enterprise): library access lives under the Policies tab

* docs(enterprise): make library access MCP wording tool-name agnostic

* docs(enterprise): point library access to the Access tab

* docs(enterprise): refresh library access table screenshot

* docs(enterprise): restricted libraries read as not found, not denied

* docs(enterprise): cleaner library access table screenshot (curated 5-library scenario)

* docs(enterprise): tightly crop library access table screenshot

* docs(enterprise): add library access control to changelog
2026-07-29 11:07:11 +03:00
Fahreddin Özcan 305dd3ca10 docs(enterprise): multi-container scaling guide (#2917)
Release / Release (push) Has been cancelled
Test / test (push) Has been cancelled
* docs(enterprise): add multi-container scaling guide

Document running On-Premise as multiple replicas with PostgreSQL + object
storage. Add the Scaling page under Deployment and cross-reference it from the
Kubernetes single-replica notes.

* docs(enterprise): migration guide for existing deployments + docker scaling pointer

- Scaling page: step-by-step migration using the built-in migrate command
  (Docker one-shot and Kubernetes Job), vector sync, encryption-key reuse
- Docker page: add a Scaling pointer

* docs(enterprise): add Settings > Scaling helper screenshots

Show the migration helper (single-container) and the multi-replica confirmation
in the migration section of the Scaling guide.

* docs(enterprise): point Scaling guide at the Helm chart and turnkey compose

- Docker Compose: reference the one-command bundled stack (Postgres + MinIO + LB)
- Kubernetes: use the Helm chart (single default, scaling.enabled to scale out)
- add on-prem / S3-compatible object storage (VECTOR_STORE_ENDPOINT)

* docs(enterprise): make Scaling deployment sections self-contained

On-prem customers get the image and docs, not the source repo, so inline the
full Docker Compose stack (with nginx.conf and .env) and the scaled Kubernetes
manifests (Secret + Deployment) instead of referencing repo files. Note the Helm
chart ships with the enterprise distribution.

* docs(enterprise): pgvector default for scaling, Postgres the only dependency

Vectors go to pgvector in the same Postgres, so object storage is no longer
required. Update config, compose (pgvector image, no MinIO), k8s secret, and the
migration (copies vectors into pgvector, no bucket sync). Object storage is now
an optional escape hatch for very large indexes.

* docs(enterprise): refresh Settings > Scaling screenshot for pgvector migration command

* docs(enterprise): pgvector only, drop the object storage option from the guide

Remove the VECTOR_STORE_URI config row and the 'Vectors on object storage'
section. Multi-replica uses Postgres + pgvector with no object storage.

* docs(enterprise): detailed pgvector provisioning guide

Expand the provisioning step with per-provider instructions (RDS/Aurora, Cloud
SQL, Azure Flexible Server, self-hosted/Docker), the 0.5.0 HNSW requirement,
CREATE EXTENSION, version verification, permission notes, and references. Add a
note on how vectors are stored (HNSW cosine, dimension from the model).

* docs(enterprise): explain the scaling model in Scale out

Every replica serves traffic and indexes; adding replicas grows both. Note how to
bound parse-vs-query contention with Max concurrent parses.

* docs(enterprise): drop SESSION_SECRET; ENCRYPTION_KEY now signs sessions

* docs(enterprise): add scaling sections to docker/kubernetes, link scaling page

- kubernetes: new Scaling section (StatefulSet -> Deployment + pgvector, Helm note)
- docker: refresh Scaling section (pgvector, turnkey compose)
- drop stale object-storage wording, both link to the Scaling guide

* docs(enterprise): add architecture diagram and a Helm page

- scaling: add an Architecture section with a Mermaid multi-replica diagram
- new Helm deployment page (install, scale, ingress, migration, values)
- add Helm to deployment nav; link it from the kubernetes and scaling pages

* docs(enterprise): move Helm page to its own PR (CTX7-1846)

* docs(enterprise): describe per-run Postgres lock instead of leader election

Match the code: scheduled jobs take a short advisory lock at fire time so one
replica runs each, rather than a persistent elected leader. Drop the leader
highlight from the architecture diagram; replicas are interchangeable.

* docs(enterprise): add Vector Stores page covering LanceDB, pgvector, and Milvus

Dedicated vector-store configuration page: backend comparison, VECTOR_STORE
selection, and Milvus / Zilliz Cloud setup. Cross-link from the scaling guide.

* docs(enterprise): note library access + SSO groups carry over in migration

The migrate command now copies per-library access rules and SSO group
memberships (and session epochs) alongside the other tables, so list them
in the migration step.
2026-07-24 10:32:20 +03:00
Fahreddin Özcan 137ad5f1b3 docs(enterprise): Other Git integration (Gerrit/Gitea over HTTPS + SSH) (#2933)
* docs(enterprise): add Other Git integration page (HTTPS + SSH)

Document ingesting private repos from self-managed Git hosts (Gerrit, Gitea,
self-hosted Bitbucket) over HTTPS basic auth and SSH deploy keys, with Docker
and Kubernetes mount examples. Clarifies that SSH keys are mounted into the
container and never stored by Context7.

* docs(enterprise): SSH deploy key is configurable in the UI (mount is the alternative)

* docs(enterprise): add Other Git screenshots + Add a repository steps

- HTTPS and SSH tab screenshots
- 'Add a repository' Steps showing the clone-URL scheme selects auth
- ssh-keyscan snippet for known_hosts

* docs(enterprise): remove em dashes from Other Git page
2026-07-22 12:53:05 +03:00
Fahreddin Özcan 26dcfcee92 docs(enterprise): add on-premise changelog page (#2904)
Adds enterprise/changelog to the On-Premise nav and the changelog page
(Mintlify <Update> components), backfilled for v1.0.0–v1.2.3.
2026-07-13 13:19:30 +03:00
Fahreddin Özcan ea82d5585a docs(enterprise): document programmatic library import/export API (#2887)
* docs(enterprise): document programmatic library import/export API

- Add POST /import-libraries endpoint reference (openapi-enterprise.json + page)
- Register it under API Reference → Parse in the nav
- Add an Automating with the API section to the Library Import feature doc,
  covering the cloud license-key export and the on-prem JSON import

* docs: update export endpoint to /api/v1/enterprise/export, plain language

Match the renamed cloud export path, move the license key into the request
body, and reword the automation section without em dashes.

* docs(enterprise): export uses Authorization header; import requires an API key

* docs(enterprise): document the force query param on import
2026-07-08 13:29:34 +03:00
Fahreddin Özcan 7366cca8d2 docs(enterprise): Confluence integration page (#2879)
* docs(enterprise): add Confluence integration page

Document connecting Confluence (Cloud and self-hosted Data Center) and
indexing a space from Add. Includes screenshots and a nav entry under
Enterprise > Integrations.

* docs(enterprise): wider Confluence settings screenshot with mock site URL
2026-07-07 11:26:40 +03:00
Fahreddin Özcan 74dc6ba95c CTX7-1760: Document GitOps for on-premise (#2816)
* CTX7-1760: document GitOps for on-premise

Add the GitOps page under the On-Premise docs: how reconciliation works, the
manifest format and fields, dashboard configuration, webhooks, disaster
recovery, and the REST API. Includes a dashboard screenshot.

* CTX7-1760: clarify GitOps webhook requirements (reachable host, push subscription)

* CTX7-1760: call out webhook caveat for pre-existing GitHub Apps

* CTX7-1760: add a Before you start prerequisites section to GitOps docs

* CTX7-1760: add GitHub Integration page; trim GitOps prerequisites to reference it

* CTX7-1760: group on-prem feature pages under a Features nav section

* CTX7-1760: move GitHub docs under an Integrations group, add setup screenshots

* Remove accidentally-staged docs/enterprise/integrations/github-actions.mdx

* CTX7-1760: use an admin API key example for the reconcile endpoint instead of a session cookie

* CTX7-1760: use connected-state GitHub App screenshot; split setup into create + install steps

* CTX7-1760: add Verify the App configuration section with permissions and webhook screenshots
2026-06-24 11:33:07 +03:00
Fahreddin Özcan 518bc98d21 docs(enterprise): add OIDC SSO guide (#2814)
Documents generic OIDC SSO setup for Context7 On-Premise, with dashboard
screenshots and a troubleshooting section. Adds the page to the On-Premise
Security nav group.
2026-06-24 11:32:54 +03:00
Fahreddin Özcan 8a6c029f65 docs(enterprise): add on-premise API reference (#2810)
* docs(enterprise): add on-premise API reference

Adds interactive API reference pages for the on-premise instance covering authentication, library search, documentation context, and all parse endpoints.

* docs(enterprise): remove duplicate openapi spec

* docs(enterprise): remove em dashes

* docs(enterprise): simplify authentication page

* docs(enterprise): add API key screenshots to authentication page

* docs(enterprise): link bearer auth description to authentication page
2026-06-23 11:22:52 +03:00
Fahreddin Özcan 2253765b3f feat(mcp): Enterprise-Managed Auth (id-jag) validation + Okta docs (#2798)
* feat(mcp): Enterprise-Managed Auth (id-jag) validation + Okta docs

* docs(enterprise): clarify Okta connection is client-side org config, drop wrong client JSON

* docs(enterprise): remove em dashes

* docs(enterprise): group Entra and Okta under Enterprise-Managed Auth, redirect old azure-apim path

* refactor docs

---------

Co-authored-by: enesgules <abdullah.enes.gules@gmail.com>
2026-06-22 11:55:06 +03:00
Fahreddin Özcan cd12120f40 docs: on-premise library import/export (#2789)
Document the offline library transfer flow: export libraries from Context7
Cloud, import the bundle into an airgapped on-premise install (snippets are
re-embedded locally). Adds the page under Enterprise > On-Premise.
2026-06-17 15:09:28 +03:00
Enes Gules 195357db70 feat(docs): enhance documentation with improved titles, descriptions, and structured steps for clarity (#2778) 2026-06-17 10:18:21 +03:00
Fahreddin Özcan b692be18bf docs: backup and restore guide for on-premise (#2758)
* docs: backup and restore guide for on-premise

* docs: add dashboard restore flow and Keep all retention

* docs: use ctx7:restore in the local restore command

* docs: use consistent library/index vocabulary in backup-restore
2026-06-16 18:27:07 +03:00
Enes Gules 574fc642ab feat(docs): add VS Code extension documentation and update all clients reference (#2757) 2026-06-12 16:39:14 +03:00
Enes Gules 06843a6b84 fix copilot cli plugin compatability (#2743) 2026-06-10 13:29:14 +03:00
Enes Gules cc011a4707 feat: add Codex client documentation and update OAuth flow details for existing clients (#2742) 2026-06-09 15:51:14 +03:00
enesakar 0a6ecdcaf2 docs pages 2026-06-05 16:13:38 +03:00
Enes Gules 2e97dae44e refactor(cli): update CLI documentation and add deprecation warning to skill commands (#2711) 2026-06-02 16:15:51 +03:00
Fahreddin Özcan 6f0f8b7b63 docs(enterprise): Azure APIM deployment guide (#2636)
* docs(enterprise): add Azure APIM deployment guide

Step-by-step guide for deploying Context7 behind Azure API Management
with Microsoft Entra ID per-user authentication via On-Behalf-Of (OBO)
token exchange. Covers APIM provisioning, Entra app registrations,
policy wiring, OAuth discovery surfaces, and connecting MCP clients
(VS Code Copilot, Cursor) through the gateway.

* docs(azure-apim): cover user pre-provisioning + fix variable typo

- Restructure Part 4 into two steps: tenant config + pre-provisioning
  users via the new dashboard card. Calls out that Context7 rejects
  unmapped oids — there is no auto-provisioning.
- Add troubleshooting entry for the unmapped-user 401 (most common
  failure once tenant config is correct).
- Fix \$APIM_NAME → \$APIM typo in the OAuth proxy provisioning
  commands; the rest of the doc uses \$APIM so the OAuth proxy
  commands would have failed as written.
2026-05-18 08:59:48 -07:00
Fahreddin Özcan 795d5da720 CTX7-1567: Add Microsoft Entra SSO setup guide for on-premise (#2496) 2026-04-30 13:16:00 +03:00
Shannon Rumsey 0b190c1b8d CTX7-1559: Update section titles and data safety content (#2491) 2026-04-22 00:54:31 +03:00
Elif Nur Deniz 648e5a2e06 chore: library refreshing docs (#2482) 2026-04-20 07:23:17 -07:00
Enes Gules 09d05bca29 docs: add new integrations for Factory AI, Mastra, and Tembo with corresponding setup instructions and images (#2428) 2026-04-09 17:32:20 +03:00
Enes Gules 58a36cea87 feat: update stale docs (#2307) 2026-03-24 10:49:49 +03:00
Shannon Rumsey 7f7b7268c3 reorganize security docs (#2293) 2026-03-21 22:26:50 -07:00
Enes Akar 383e127bd5 fix(docs): reorder deployment menu to show Docker before Kubernetes (#2248)
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-16 09:00:27 -07:00
Fahreddin Özcan f7a79a9489 feat(docs): split deployment into dedicated Docker and Kubernetes guides (#2222)
The single deployment.mdx page implied Kubernetes-only deployment. Split it into
a deployment/ folder with separate Docker and Kubernetes guides, and simplify the
on-premise getting started page to link to them via Mintlify cards.
2026-03-16 13:05:42 +03:00
Fahreddin Özcan 099715b657 Add Kubernetes deployment guide for on-premise (#2219)
New deployment.mdx page under the On-Premise section covering
StatefulSet, Service, Ingress manifests, registry auth, networking
requirements, operations, and troubleshooting for K8s deployments.
2026-03-13 16:46:16 +03:00
Fahreddin Özcan 31b4fb8435 feat(cli): add docs skill and align CLI output with MCP format (#2176)
* feat(docs): add dedicated docs skill and restructure CLI documentation

- Add new `docs` skill as a single-file skill for documentation retrieval
- Align skill prompts with MCP tool descriptions (selection process, query guidance, 3-call limit)
- Enrich CLI docs page with result fields, query tips, and version-specific IDs
- Move CLI page to Overview section in docs nav
- Make `query` required for `ctx7 library` across all skills and docs
- Update trust score display label in skills.mdx

* feat(cli): align library output format with MCP labels

Use labeled fields and categorical Source Reputation labels
(High/Medium/Low/Unknown) instead of numeric trust scores to match
the MCP transport format.

* refactor: move skills from .agents/skills to skills/ at repo root

Source-control location for skills — users install them into
.agents/, .claude/, etc. via the CLI. Also updates install
instructions to use `npm install -g ctx7@latest` or `npx ctx7@latest`.

* docs: use natural-language query examples across skills and CLI docs

Replace keyword-style queries ("useEffect cleanup") with full
question-style queries ("How to clean up useEffect with async
operations") to better demonstrate how the query parameter works.

* docs: fix trust score description to show numeric range
2026-03-10 16:04:05 +03:00
enesakar 27ccb7efba ee folder 2026-03-09 14:04:59 -07:00
Fahreddin Özcan c0d1c9e07f Add enterprise deployment docs (#2033)
* Add on-premise deployment docs

Hidden page covering what's included, setup steps, configuration
reference, MCP client connection, and architecture diagram.

* Update on-premise docs: switch from tar.gz to GHCR registry pull

Replace curl+docker load approach with standard docker login + docker pull
using a license-gated registry token from context7.com.

* Fix on-premise docs: separate auth step, clarify docker compose pull

- Split into distinct "Authenticate" and "Configure and start" steps
- Remove redundant docker pull (docker compose up -d handles it)
- Add driver: local to volumes declaration
- Clarify that docker login credentials persist for docker compose

* docs: mention docker pull as alternative to docker compose pull

* docs: use -p flag instead of --password-stdin for docker login

* Move on-premise docs to enterprise/, add configuration details

- Move on-premise.mdx from docs root to docs/enterprise/
- Add setup wizard documentation
- Add AI provider settings with OpenRouter and local model examples
- Add embedding settings with incompatibility warning
- Add access control section with permission toggles
- Add volume persistence warning
- Remove env vars for AI/git config (now UI-configured)

* Docs: clarify git tokens, add health check example, group operations

* Docs: extract LICENSE_KEY variable for easier configuration
2026-03-03 06:21:29 -08:00
Enes Gules dfe9863f30 refactor: update terminology from "team" to "teamspace" across documentation (#2012) 2026-02-26 01:01:42 +03:00
enesakar e866047baa enterprise page for docs 2026-02-20 08:33:06 -08:00
Enes Gules 62d6bd66e1 add chat-widget how-to documentation entry (#1813) 2026-02-13 18:03:03 +03:00
Fahreddin Özcan 88242f5b47 docs: library verification docs with imgs (#1548) 2026-01-26 09:27:44 -08:00
enesakar 33bfbcdb9b cli and skills docs 2026-01-22 09:56:09 -08:00
enesakar 3299ad311a docs menu update 2026-01-12 14:45:23 -08:00
Fahreddin Özcan 51996f2489 docs(CTX7-1040): add OpenCode to clients list (#1432)
* docs(CTX7-1040): add OpenCode to clients list

* remove api key warnign
2026-01-12 18:12:19 +03:00
Fahreddin Özcan 3553cb2023 fix: claude code plugin name and details image (#1417)
* fix: claude code plugin name and details image

* fix: claude code plugin name and details image

* update skill prompt

* fix: update plugin.json name and improve agent/skill instructions

* fix: update plugin README with correct install commands

* fix: remove max 3 calls warning
2026-01-10 22:24:20 +03:00
Fahreddin Özcan b41e7c8482 docs: add dedicated Cursor and Claude Code client guides with plugin marketplace (#1385)
* feat(plugins): add Context7 plugin for Claude Code

Add the context7 plugin with:
- MCP server configuration (.mcp.json)
- Plugin metadata (.claude-plugin/plugin.json)
- docs-researcher agent for focused documentation lookups
- /context7:docs command for manual queries
- documentation-lookup skill for auto-triggering

* docs(clients): add dedicated Cursor and Claude Code guides

Add comprehensive client-specific documentation:

Cursor:
- One-click and manual installation (remote/local)
- Rules setup via settings and .cursorrules
- Library IDs, version pinning, example prompts
- Tips for Composer integration

Claude Code:
- CLI installation commands
- Plugin installation (skills, agents, commands)
- docs-researcher agent usage
- /context7:docs command reference
- CLAUDE.md rules setup

Uses Mintlify components: Tabs, Steps, Cards, Accordions

* docs: add Clients navigation and cross-references

- Add "Clients" group to docs.json navigation
- Add note in all-clients.mdx linking to dedicated guides

* update warnings

* docs: redesign claude client docs

* docs: update cursor docs with images

* docs: update cursor installation ui

* feat: add claude marketplace docs

* update marketplace

* update mp-plugin name

* finalize cc plugin installation

* update using context7 section

* feat: make claude code oauth default
2026-01-10 10:47:09 -08:00
Fahreddin Özcan f0ee85d0c7 CTX7-879: Context7 Vercel AI SDK Docs (#1155)
* feat: context7 vercel ai sdk tools package

* ci: remove master target condition on test action

* ci: manual actions trigger for test

* ci: always run all tests

* update tests and imports

* ci: typecheck command

* fix: tests

* docs: add readme

* update folder structure and tool descriptions

* docs: context7-ai-sdk

* tests: fix test env vars

* ci: bump pnpm version

* update ai sdk step count api

* Add stopWhen to docstring examples

* update tests

* update prompt name

* update context7 agent name

* update tool description var to description

* make context7agent config optional

* ci: add changeset

* make context7-sdk peer deps

* update pnpm-lock.yaml

* update package name to @upstash/context7-tools-ai-sdk

* remove check workflow

* update pnpm lock

* make the agent a class instead of function

* replace all name instances

* add agent generate test

* update docs with latest changes and updated veai sdk examples

* finalize docs

* docs: remove duplicate H1 headers from AI SDK documentation pages

* simplify agent config

* fix refs

* remove changeset

* feat: update diagram with query param

* fix: address reviews

---------

Co-authored-by: enesgules <abdullah.enes.gules@gmail.com>
2026-01-08 21:15:35 +03:00
Fahreddin Özcan ef82f3057c CTX7-884: OAuth Support for MCP (#1176)
Co-authored-by: enesgules <abdullah.enes.gules@gmail.com>
2026-01-08 20:17:19 +03:00
Fahreddin Özcan b3cd38a32c CTX7-982: Update Context7 SDK with API v3 (#1335)
* feat: update sdk with API v3

* feat: simplify sdk types

* feat: simplify return types and fields

* fmt

* chore: seperate type and utils locations

* chore: update sdk readme

* docs: update sdk docs with new updates

* fix: update vitest config

* chores

* update tools-ai-sdk package

* update tests with proper types

* feat: update tools-ai-sdk package tools

* chore: update tools-ai-sdk changeset

* update changesets
2026-01-05 17:34:51 +03:00
enesakar 912b16fe5e update docs and readme 2025-12-30 14:23:45 -08:00
enesakar f13e3a1bec docs fixes 2025-12-29 21:51:20 -08:00
enesakar 853003de24 docs updates 2025-12-29 21:39:14 -08:00
Enes Gules e859a6b990 feat: add contextual options for copy, view, ChatGPT, and Claude to docs config (#1272) 2025-12-19 11:36:26 +03:00
Fahreddin Özcan 11a733de6a CTX7-881: Claim Library Docs (#1126) 2025-12-01 21:30:04 +03:00