This file records notable changes to Cortex Docs.
The project uses Semantic Versioning. Each release contains the same three change sections.
- None.
- None.
- None.
- Deploy free documentation hosting for public GitHub repositories with
cortex deploy, publishing your existing Markdown to a*.cortexdocs.devsubdomain. - Serve a live MCP server directly from a public repository with
cortex mcp-serve https://github.com/OWNER/REPO, without a local checkout. - Documentation sites are now published through Cloudflare Static Assets for direct, low-latency delivery of hosted docs.
- Fixed in-page links to Markdown headings so they scroll to the correct section in the hosted documentation site, even before content has fully loaded.
- Removed a conflicting cache-control header on static hosted assets that could cause stale or inconsistent caching behavior.
- None.
- None.
- None.
- Documented the
primaryColorconfiguration option in the README, showing how to set the documentation accent color as a six-digit hex value.
- None.
- None.
- Sharpened the README demo animation and poster image for better clarity.
- None.
- None.
- Replaced the static SVG overview in the README with an animated terminal demo GIF and PNG for a more interactive preview of Cortex.
- Added a Product Hunt badge and a changelog link to the README.
- None.
- None.
- Added a Product Hunt badge and a link to the changelog on the README.
cortex docs buildnow exports static HTML, CSS, JavaScript, and documentation data for deployment to a static web host.
- Fixed the documentation layout and navigation on mobile screens.
- Fixed MCP tool links that scrolled to the wrong position after the setup guide loaded.
- Excluded workspace test dependencies from the CLI release package to prevent dependency conflicts during CI packaging.
- Removed
cortex docs start. Usecortex docs servefor a local preview with file watching. Host production output as static files without a Node.js server.
- None.
- Fixed generated Go GraphQL clients failing to reconnect and resubscribe WebSocket subscriptions after a connection was dropped or a subscribe write failed.
- None.
- None.
- None.
- Improved the README heading hierarchy for better structure and readability.
- None.
- Disabled analytics and cookie controls unless the current hostname is explicitly listed in
enabled_hosts, instead of enabling tracking by default when the list was empty.
- Simplified the README header presentation.
- None.
- None.
- Added a visual product overview, a 60-second tour, a workflow comparison, and clearer project links to the README.
- Added automatic GitHub Releases with notes from the generated changelog.
- None.
- None.
- None.
- None.
- None.
- Added a link to the official Cortex Docs website in the README.
- Added consent-aware Google Analytics 4 integration, configurable via a new
analyticssite config option (google_analytics_id,enabled_hosts,privacy_url), including a cookie consent banner with a link to your privacy policy and no advertising signals collected.
- None.
- Documentation updated to explain how to configure Google Analytics through the new
analyticsconfig instead of manually embedding tracking scripts viacustom_head_html.
- The "Built with Cortex" badge now records each unique website hostname that loads it, so you can see which sites are displaying your badge.
- None.
- None.
- None.
- None.
- None.
- None.
- None.
- None.
- Added a
try_now_urlsource option for gRPC and OpenRPC specs, enabling the "Try now" panel to stream live, real-time responses (e.g. server-streaming/watch operations) through a browser-compatible HTTP bridge.
- Fixed search results navigating to the wrong page; selecting a REST, GraphQL, WebSocket, or OpenRPC result (including from recent searches) now opens its canonical API reference route.
- Fixed streaming responses in the "Try now" panel being logged as garbled or incomplete lines when chunks split mid-line; output is now buffered and displayed as complete lines.
- Fixed WebSocket connections dropping the
graphql-transport-wssubprotocol negotiation, which could break interactive GraphQL subscription testing.
- None.
- None.
- None.
- None.
- None.
- Fixed the demo API worker preview so it serves the branding logo asset locally instead of returning a missing-file error.
- Fixed the local dev watcher so changes inside the docs UI and docs site no longer trigger unnecessary rebuilds of unrelated packages.
- The docs site and demo site are now deployed as static Cloudflare assets instead of Workers, so pages load without invoking a Worker script and no longer count against the Workers daily request allowance.
- None.
- Fixed the packaged CLI's
docs dev/serveruntime sync so files and directories in the docs-ui runtime are properly copied and stale entries removed, instead of relying on broken symlinks. - Fixed the CLI's Next.js config so the
@cortex-docs/docs-uipackage transpilation and module alias are always applied, preventing build/runtime failures in the packaged CLI. - Fixed
docs serveto run Next.js dev with the webpack bundler explicitly, avoiding dev-server errors in the packaged CLI.
- API reference sidebars (navigation and code snippets) now automatically show or collapse based on available screen width, instead of only reacting to fixed breakpoints, improving usability on narrower windows.
- None.
- Fixed the demo docs Cloudflare Worker deployment by removing a CPU time limit setting that is unsupported on the Cloudflare Workers Free plan, which was blocking deployment.
- None.
- None.
- Fixed the demo docs Cloudflare Worker deployment to work on the Cloudflare Workers Free plan.
- None.
- The CLI now supports
--version/-Vto print the installed Cortex Docs version.
- Fixed the published CLI package so it installs with all required runtime dependencies and runs correctly (the previous release was not runnable after install).
- Fixed a hydration warning triggered by custom
<head>HTML injected via site configuration.
- Docs and SDK pages are now pre-rendered at build time instead of forced dynamic rendering, improving page load performance.
- Increased the Cloudflare Worker CPU time limit to prevent timeouts on larger documentation builds.
- Enabled cache interception with a static-assets incremental cache for faster repeat responses on the deployed docs site.
- Documentation pages now support an
appearancequery parameter (?appearance=darkor?appearance=light) to set the initial theme for that page, taking priority over the project theme and the visitor's stored preference.
- None.
- None.
- Added
custom_head_htmlconfiguration option to inject trusted HTML (metadata, stylesheets, analytics scripts) into the<head>of every documentation page.
- Fixed the generated PHP GraphQL client to properly reconnect after receiving WebSocket close frames instead of treating them as regular messages.
- None.
- None.
- None.
- Clarified documentation to describe the generated MCP server (rather than MCP tools) for REST, GraphQL, OpenRPC, and WebSocket payload preparation.
- Clarified that generated packages and the MCP server can be published to language registries and GitHub repositories.
- None.
- Fixed
cortex docs servenot picking up changes to docs UI source files (app, components, hooks, lib, public) during local preview, requiring a manual restart.
- Renamed the "Built by Cortex" footer badge to "Built with Cortex," with updated branding, sizing, and asset URLs (
/images/built-with-cortex.svg), plus backward-compatible redirects from the old badge URLs. - Expanded the Getting Started guide with a features overview, a supported API sources table, a link to the live demo, guidance on adding custom Markdown docs, and instructions for generating the MCP server standalone.
- None.
- None.
- Redesigned the "Built by Cortex" footer badge into a themed card with a new transparent, dark-mode-aware logo.
- The Cortex logo is now served from a dedicated static asset host (
static.cortexdocs.dev), with the previous asset URL permanently redirecting to it for backward compatibility.
- None.
- Fixed a race condition in generated Ruby WebSocket clients where the reader thread could fire an open or close event before callbacks were registered, causing missed connection events.
- None.
- None.
- None.
- None.
- Published
@cortex-docs/mcp, an MCP server that exposes the Cortex Docs product documentation. - Deployed the Cortex Docs product documentation site at https://docs.cortexdocs.dev.
- None.
- Added a "Live sites" section to the README linking to both the documentation site and the demo.
- Documented the full release flow, including MCP package generation/publishing and product docs deployment, in RELEASING.md and CONTRIBUTING.md.
- The "Built by Cortex" badge on docs pages is now served as an image from a Cloudflare-hosted endpoint instead of inline markup.
- None.
- None.
- None.
- None.
- Added a live demo link to the README so users can try Cortex Docs online.
- None.
- None.
- None.
- Added a "Try now" button to the mobile SDK reference code panel for quickly opening the interactive request tester.
- Fixed the docs dev script not waiting for the demo API worker to become healthy before starting, which could cause flaky local development and demo failures.
- Fixed SVG logo sanitization stripping text elements and their typography (font family, size, weight, decoration, anchor), so text-based logos now render correctly.
- Fixed the demo API worker's GraphQL module resolution via an explicit
graphqlalias in the Wrangler config. - Packages are now published under the
@cortex-docsnpm scope instead of@cortex; update install commands (e.g.npm install --global @cortex-docs/cli) accordingly.
- The mobile SDK code panel now truncates long labels and keeps the expand toggle icon from shrinking, improving layout on small screens.
- Added support for generating MCP servers from OpenRPC specifications, including a new Eta-based template renderer for MCP tool handlers.
- Added automatic OpenAPI server URL resolution so generated SDKs can determine the correct base URL from the spec.
- Added comprehensive documentation covering quickstart, configuration, OpenAPI/GraphQL/OpenRPC/WebSocket SDK generation, MCP servers, and publishing SDKs to package registries.
- Fixed generated SDK identifiers colliding with reserved language keywords by hardening the naming utilities.
- Fixed incomplete OpenAPI validation and error handling in the OpenAPI parser.
- Fixed the "Try Now" modal not surfacing API request errors correctly.
- Fixed generated SDK handlers not normalizing the API base URL, which could produce malformed requests.
- Broadened OpenRPC version validation to accept a wider range of spec versions.
- Improved gRPC and WebSocket handling in generated SDK snippets and reference docs.