Changelog

The npm packages (orbitdocs and @orbitdocs/*) are released together and share one version: install the same version of each. The self-hosted platform has its own versions.

npm packagesCopy Anchor Link

0.1.0Copy Anchor Link

Initial releaseCopy Anchor Link

@orbitdocs/ai

• Ask AI: streamed, cited answers from the docs with OpenAI, Anthropic, Google or any OpenAI-compatible provider; only pages the reader may open are used.
• Docs MCP server (/mcp) and one MCP server per API (/mcp/<api>) whose tools call the API with the client's credentials.
• A provider failure is reported to the reader as an error with its HTTP status, never as an empty answer.

@orbitdocs/auth

• Private docs: sign-in with Google, Microsoft Entra ID, Okta, Auth0, Clerk or Keycloak (OpenID Connect), or reuse of the product's own Supabase, Clerk, Firebase or Appwrite session.
• Groups from emails, domains and IdP groups; path rules plus page and API constraints, where the stricter rule always wins.
• Personalization hook, audit trail (file or webhook), and handlers for Express, Nest, Next and edge runtimes.
• A fetch option that every outbound request uses, so a host can restrict where requests go.

orbitdocs

• orbitdocs init, dev, build, extract, check and publish.
• orbitdocs sdk (TypeScript with Hey API; Python, Go, Java, C# and PHP with OpenAPI Generator), sdk test, and CI workflows for GitHub and GitLab.
• orbitdocs mock (a mock server from the spec) and orbitdocs lint (Spectral).

@orbitdocs/core

• defineConfig() and the orbitdocs.config.ts schema (zod) with defaults: site, navigation (header links, footer columns and a "Built by" credit), layout, theme, banner, search, code blocks, API sources, private docs, Ask AI, SDKs and mock settings.
• API sources from a NestJS app (routes: 'opt-in' with @DocsOperation, or 'all' for every @nestjs/swagger route), an OpenAPI file or a URL.
• Config warnings for options a layout ignores.

@orbitdocs/nestjs

• @DocsOperation and @DocsContent decorators, and spec extraction from a Nest app (preview mode, no database needed).
• mountOrbitDocs() serves the docs site from the Nest app, with private docs and Ask AI on the same server.

@orbitdocs/next

• withOrbitDocs() Next.js plugin and the docs app's routes: guides (MDX), API reference, API client, llms.txt, Markdown twins of every page; static export, server mode (proxy.ts) or served by Nest.
• Fumadocs layouts (docs, notebook, flux, glass, home) driven by the config, and lib/overrides.tsx (OrbitOverrides) for React-only options.
• Animated landing-page components: Hero (with logo and footnote), Section, Features, Bento, CodeShowcase, Terminal, Flow, Stats, Logos, Showcase, BrowserFrame, Comparison, CallToAction and SiteFooter (columns, social links and a "Built by" credit).
• Reference pages render one operation and load the rest by group, so large APIs stay small per page.
• Private docs in static builds: reader variants of the sidebar, search index, API menu and specs.
• GitHub-style alerts and extra content per API operation (content/reference/<api>/<op>.mdx).

@orbitdocs/openapi

• Loads, upgrades and bundles OpenAPI 3.0/3.1 (and Swagger 2.0) documents into the reference model the UI renders: groups, operations, parameters, bodies, responses, examples and models.
• Stable slugs and stableStringify() for reproducible specs; operation pages as Markdown for search, llms.txt and Ask AI.
• Per-status example bodies, including NestJS's default error bodies.

@orbitdocs/ui

• API reference UI: operations, schemas, examples, code samples in many languages, and "Test Request".
• API client built on HeroUI: collections, request tabs, environments, history, scripts, code generation, a collection runner, a command palette, right-click menus, and settings for layout, density, font and accent.
• Ask AI panel and the shared theme (styles.css).

Self-hosted platformCopy Anchor Link

0.1.0Copy Anchor Link

Initial releaseCopy Anchor Link

• Self-hosted platform: a dashboard with projects, production and preview deployments, rollback, an API registry with lint, analytics and an audit log.
• Git sync with GitHub and GitLab (including self-managed), with a build queue on pg-boss, commit statuses and preview comments.
• Team roles, invitations, password and SSO sign-in, and SCIM provisioning.
• Custom domains with automatic TLS (Caddy), and Docker Compose deployment.
• Encrypted per-project build variables and site environment variables; hosted sites never see the platform's own environment.
• Hosted sites can't reach private, loopback or link-local addresses; SITE_OUTBOUND_ALLOW lists the exceptions.