From d7e358552f4a7354ea0a55a59f698689dcaff77d Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Tue, 30 Jun 2026 13:35:24 +0000 Subject: [PATCH 1/2] chore: add changelog and release notes for v1/v2 - Add root CHANGELOG.md with platform history (Common Changelog style) - Add docs/releases/v1.0.0.mdx with v1 release notes - Add docs/releases/v2.0.0.mdx with v2 release notes This is a clean rebase of PR #483 onto the latest main branch, removing the noise from the previous branch that was based on the ai branch. Co-authored-by: Alex Duke --- CHANGELOG.md | 116 +++++++++++++++++++++++++++++++++++++++ docs/releases/v1.0.0.mdx | 96 ++++++++++++++++++++++++++++++++ docs/releases/v2.0.0.mdx | 91 ++++++++++++++++++++++++++++++ 3 files changed, 303 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 docs/releases/v1.0.0.mdx create mode 100644 docs/releases/v2.0.0.mdx diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..a5bed961 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,116 @@ +# Changelog + +Platform changes to docs.page. Release notes: [2.0.0](./docs/releases/v2.0.0.mdx) · [1.0.0](./docs/releases/v1.0.0.mdx). + +## [2.0.0] - 2026-06-23 + +### Removed + +- **Breaking:** remove standalone `website/` and `api/` deployables ([#470](https://github.com/invertase/docs.page/pull/470)) +- **Breaking:** remove Algolia DocSearch integration — use built-in FlexSearch `search.json` instead +- Remove Redis-backed bundle cache in favour of surrogate cache control ([`0228337`](https://github.com/invertase/docs.page/commit/0228337)) + +### Added + +- Add unified Next.js application for hosting, bundling, and API routes ([`a546632`](https://github.com/invertase/docs.page/commit/a546632)) +- Add shared `packages/mdx-bundler` document IR pipeline ([`be18d1d`](https://github.com/invertase/docs.page/commit/be18d1d)) +- Add MCP server endpoint, skills resources, and installation dialog per repository ([`75c1ab2`](https://github.com/invertase/docs.page/commit/75c1ab2), [`d1728bf`](https://github.com/invertase/docs.page/commit/d1728bf)) +- Add page action menu: copy Markdown, view `.md`, Open in Claude, and MCP deeplinks ([`354770c`](https://github.com/invertase/docs.page/commit/354770c)) +- Add `llms.txt` and `llms-full.txt` endpoints ([`d88f7c4`](https://github.com/invertase/docs.page/commit/d88f7c4)) +- Add Ask AI agent panel and configurable agent questions in `docs.json` ([`4cac172`](https://github.com/invertase/docs.page/commit/4cac172), [`8dc1819`](https://github.com/invertase/docs.page/commit/8dc1819)) +- Add command palette with tab navigation, Ask AI, and MCP shortcuts ([`964f566`](https://github.com/invertase/docs.page/commit/964f566), [`12148bc`](https://github.com/invertase/docs.page/commit/12148bc)) +- Add in-page FlexSearch with title-only mode ([`964f566`](https://github.com/invertase/docs.page/commit/964f566)) +- Add FlexSearch-backed `search.json` per repository ([`76eaf1a`](https://github.com/invertase/docs.page/commit/76eaf1a)) +- Add `sitemap.xml` and `robots.txt` routes per repository ([`02fa436`](https://github.com/invertase/docs.page/commit/02fa436), [`65f5d45`](https://github.com/invertase/docs.page/commit/65f5d45)) +- Add Mermaid diagram rendering in MDX ([`de3b9e3`](https://github.com/invertase/docs.page/commit/de3b9e3)) +- Add optional site banner in `docs.json` ([`54479dd`](https://github.com/invertase/docs.page/commit/54479dd)) +- Add shadcn/ui preset themes and reworked documentation chrome ([`0cb7003`](https://github.com/invertase/docs.page/commit/0cb7003), [`f7b97d7`](https://github.com/invertase/docs.page/commit/f7b97d7)) +- Add CLI `preview` and `agent` commands sharing the production bundler ([#472](https://github.com/invertase/docs.page/pull/472), [#470](https://github.com/invertase/docs.page/pull/470)) +- Add configurable agent rate limiting ([`cf39bb3`](https://github.com/invertase/docs.page/commit/cf39bb3)) + +### Changed + +- **Breaking:** move local development to Bun workspace (`cd app && bun dev`) +- Rework `@docs.page/cli` on Bun with shared validation and rendering checks ([#470](https://github.com/invertase/docs.page/pull/470)) +- Serve `docs.json` schema from the Next.js app ([`88dec3a`](https://github.com/invertase/docs.page/commit/88dec3a)) +- Port MDX components to shared IR renderer ([`be18d1d`](https://github.com/invertase/docs.page/commit/be18d1d), [`f938182`](https://github.com/invertase/docs.page/commit/f938182)) +- Improve GitHub file resolution via jsDelivr ([`16405d3`](https://github.com/invertase/docs.page/commit/16405d3)) +- Maintain v1 `docs.json` compatibility during migration ([`94fd1f8`](https://github.com/invertase/docs.page/commit/94fd1f8)) +- Relocate GitHub webhook handling into `app/` ([`aa5a7aa`](https://github.com/invertase/docs.page/commit/aa5a7aa)) +- Rework Open Graph image generation ([`a6e43d6`](https://github.com/invertase/docs.page/commit/a6e43d6)) +- Extend CLI `check` with rendering validation ([`3faf391`](https://github.com/invertase/docs.page/commit/3faf391)) + +### Fixed + +- Register GitHub webhook listener once per process ([`5340652`](https://github.com/invertase/docs.page/commit/5340652)) +- Serve correct `search.json`, sitemap, and `llms.txt` URLs on custom domains ([`5593ebb`](https://github.com/invertase/docs.page/commit/5593ebb), [`25e3b7a`](https://github.com/invertase/docs.page/commit/25e3b7a)) +- Add canonical URLs and Open Graph metadata for documentation pages ([`c06728d`](https://github.com/invertase/docs.page/commit/c06728d)) +- Fix MCP endpoint URL and copy actions ([`5fc5e5e`](https://github.com/invertase/docs.page/commit/5fc5e5e)) +- Respect `showPageImage` and frontmatter edge cases ([#420](https://github.com/invertase/docs.page/issues/420), [#396](https://github.com/invertase/docs.page/issues/396)) +- Fix client navigation hydration handling ([#419](https://github.com/invertase/docs.page/issues/419)) +- Prevent internal sidebar links from opening in a new tab ([#417](https://github.com/invertase/docs.page/pull/417)) +- Improve grouped sidebar collapse, text wrapping, and mobile menu behaviour ([#399](https://github.com/invertase/docs.page/issues/399), [`d21f8ad`](https://github.com/invertase/docs.page/commit/d21f8ad)) +- Align code fence and fenced block styling ([`ffb7a1a`](https://github.com/invertase/docs.page/commit/ffb7a1a)) +- Make headings clickable and improve card link affordance ([`f8692c1`](https://github.com/invertase/docs.page/commit/f8692c1), [`fb4a1f0`](https://github.com/invertase/docs.page/commit/fb4a1f0)) +- Fix steps component spacing and nested children ([`abf12a3`](https://github.com/invertase/docs.page/commit/abf12a3), [`aa8bfbc`](https://github.com/invertase/docs.page/commit/aa8bfbc)) +- Fix CLI local preview rendering via shared production bundler ([#472](https://github.com/invertase/docs.page/pull/472), [`5bcc76b`](https://github.com/invertase/docs.page/commit/5bcc76b)) +- Fix preview page WebSocket client and doc rendering ([`402d187`](https://github.com/invertase/docs.page/commit/402d187)) +- Skip analytics scripts in local preview mode ([`c8d885f`](https://github.com/invertase/docs.page/commit/c8d885f)) +- Hide ref badge in local preview mode ([`e26ea34`](https://github.com/invertase/docs.page/commit/e26ea34)) +- Improve markdown parsing for preview and production parity ([`202ab7e`](https://github.com/invertase/docs.page/commit/202ab7e)) + +[2.0.0]: https://github.com/invertase/docs.page/releases/tag/cli-v2.0.0 + +## [1.0.0] - 2024-08-29 + +### Added + +- Publish documentation from public GitHub repositories with zero custom site setup ([#359](https://github.com/invertase/docs.page/pull/359)) +- Support `docs.json` for name, description, logo, favicon, theme, header, sidebar, tabs, anchors, and SEO +- Support third-party analytics via `docs.json` scripts (Google Tag Manager, Google Analytics, Plausible) ([#211](https://github.com/invertase/docs.page/pull/211), [#233](https://github.com/invertase/docs.page/pull/233)) +- Render MDX with built-in components: tabs, steps, callouts, code blocks, code groups, cards, accordion, property, and headings +- Add embed components for YouTube, Vimeo, embedded Tweets, and HTML5 video ([#180](https://github.com/invertase/docs.page/pull/180), [#194](https://github.com/invertase/docs.page/pull/194)) +- Provide live previews for branches, pull requests, and commits with hydration reload ([#340](https://github.com/invertase/docs.page/pull/340)) +- Install GitHub App webhooks for automatic pull request preview URLs +- Support custom and vanity domains ([#271](https://github.com/invertase/docs.page/pull/271)) +- Support optional Algolia DocSearch integration +- Generate Open Graph images for documentation pages ([`150d6da`](https://github.com/invertase/docs.page/commit/150d6da)) +- Support global variable injection, per-page frontmatter, redirects, and previous/next controls ([#216](https://github.com/invertase/docs.page/pull/216)) +- Support dark and light mode with syntax-highlighted code blocks +- Expose `docs.json` JSON Schema at `/schema.json` +- Bundle markdown through Express API with remark/rehype validation plugins ([`6126288`](https://github.com/invertase/docs.page/commit/6126288)) +- Support HTML comments and math in MDX ([#205](https://github.com/invertase/docs.page/pull/205)) +- Load custom domain routing from a remote domains list ([`46ec893`](https://github.com/invertase/docs.page/commit/46ec893)) +- Add middleware block list for unwanted request paths ([`ff9ecef`](https://github.com/invertase/docs.page/commit/ff9ecef)) +- Support sidebar group heading icons and external link icons ([`5d80271`](https://github.com/invertase/docs.page/commit/5d80271), [`ebc272c`](https://github.com/invertase/docs.page/commit/ebc272c)) +- Upgrade FontAwesome icons to 6.7.2 ([`304b62f`](https://github.com/invertase/docs.page/commit/304b62f)) +- Add `@docs.page/cli` with `init` and `check` commands ([#359](https://github.com/invertase/docs.page/pull/359)) + +### Changed + +- Rework platform UI and architecture in the 2024 refresh ([#359](https://github.com/invertase/docs.page/pull/359)) +- Split rendering (`website/`) and bundling (`api/`) into separate deployables ([`f862c15`](https://github.com/invertase/docs.page/commit/f862c15)) +- Move Open Graph image generation into the main website application ([`a275ff9`](https://github.com/invertase/docs.page/commit/a275ff9)) +- Initialize Google Tag Manager and Google Analytics after page load ([`9a05df6`](https://github.com/invertase/docs.page/commit/9a05df6)) +- Improve error pages and API error handling ([#336](https://github.com/invertase/docs.page/pull/336)) + +### Fixed + +- Respect `showPageImage` when rendering pages ([#420](https://github.com/invertase/docs.page/issues/420)) +- Fix hydration state handling on client-side navigation ([#419](https://github.com/invertase/docs.page/issues/419)) +- Prevent non-external sidebar links from opening in a new tab ([#417](https://github.com/invertase/docs.page/pull/417)) +- Improve collapsing behaviour of grouped sidebar items ([#399](https://github.com/invertase/docs.page/issues/399)) +- Treat frontmatter `false` as false instead of falling back to defaults ([#396](https://github.com/invertase/docs.page/issues/396)) +- Handle vanity domain redirects ([#363](https://github.com/invertase/docs.page/pull/363)) +- Handle redirect paths and prioritise domain URLs correctly ([`390da36`](https://github.com/invertase/docs.page/commit/390da36), [`159ec2b`](https://github.com/invertase/docs.page/commit/159ec2b)) +- Encode non-Latin characters in URLs ([`17d9197`](https://github.com/invertase/docs.page/commit/17d9197)) +- Truncate long sidebar titles with an ellipsis ([`de11419`](https://github.com/invertase/docs.page/commit/de11419)) +- Ensure image zoom (RMIZ) styles are bundled ([#379](https://github.com/invertase/docs.page/issues/379)) +- Fix Shiki CSS variable theming for code blocks ([#338](https://github.com/invertase/docs.page/pull/338)) +- Improve back navigation and error page messaging ([#337](https://github.com/invertase/docs.page/pull/337)) +- Fix component navigation links ([#346](https://github.com/invertase/docs.page/pull/346)) +- Hide SVG title elements in rendered output ([`02bf3f1`](https://github.com/invertase/docs.page/commit/02bf3f1)) +- Improve mobile header and layout styling ([`14ccd40`](https://github.com/invertase/docs.page/commit/14ccd40)) +- Fix spelling in documentation ([#416](https://github.com/invertase/docs.page/pull/416)) + +[1.0.0]: https://github.com/invertase/docs.page/releases diff --git a/docs/releases/v1.0.0.mdx b/docs/releases/v1.0.0.mdx new file mode 100644 index 00000000..048b2c16 --- /dev/null +++ b/docs/releases/v1.0.0.mdx @@ -0,0 +1,96 @@ +--- +title: Release notes — v1.0.0 +description: Instant, zero-configuration docs from public GitHub — the docs-as-code platform for open-source developers. +--- + +# Release notes — v1.0.0 + +**Ship documentation, like you ship code.** + +docs.page **1.0.0** is the docs-as-code platform for open-source developers: publish beautiful documentation instantly from markdown in a public GitHub repository, with zero configuration. Content is sourced directly from GitHub — no build pipelines, hosting setup, or website maintenance. + +**See also:** [CHANGELOG](../../CHANGELOG.md#100---2024-08-29) + +--- + +## New Features + +### Documentation hosting + +- Zero-config documentation sites from public GitHub repositories at `https://docs.page/{owner}/{repo}` ([#359](https://github.com/invertase/docs.page/pull/359)) +- Push-to-publish — docs.page serves the default branch automatically when you push to GitHub +- `docs.json` configuration for name, description, logo, favicon, theme, header, content options, SEO, analytics scripts, and search +- Sidebar navigation with nested groups, page icons, tab navigation, and anchor links above the sidebar +- Global variables, per-page frontmatter, redirects, and previous/next page links ([#216](https://github.com/invertase/docs.page/pull/216)) +- Dark and light themes with Shiki syntax highlighting +- Vanity URLs at `{owner}.docs.page/{repo}` when the subdomain matches your GitHub owner or username, with no extra configuration +- Static assets alongside documentation in the repository +- JSON Schema for `docs.json` at `/schema.json` + +### MDX components and content + +- Built-in components: tabs, steps, callouts, code blocks, code group, cards, accordion, property lists, and headings ([#359](https://github.com/invertase/docs.page/pull/359)) +- Icons (FontAwesome) and images with zoom +- Embeds for Tweet, YouTube, Vimeo, and HTML5 video ([#180](https://github.com/invertase/docs.page/pull/180), [#194](https://github.com/invertase/docs.page/pull/194)) +- Custom components — extend MDX with your own React components +- HTML comments and math support in MDX ([#205](https://github.com/invertase/docs.page/pull/205)) + +### Previews and integrations + +- [docs.page GitHub App](https://github.com/apps/docs-page) — comments on new pull requests with a preview URL for the PR documentation +- Live previews for branches, pull requests, and commits with hydration reload ([#340](https://github.com/invertase/docs.page/pull/340)) +- Optional Algolia DocSearch, configured in `docs.json` +- Local preview at [docs.page/preview](https://docs.page/preview) using the browser File System API to read your local `docs.json` and `docs/` folder +- Open Graph image generation for shared links ([`150d6da`](https://github.com/invertase/docs.page/commit/150d6da)) + +### CLI (`@docs.page/cli` 1.x) + +- `init` — scaffold `docs.json` and starter documentation ([#359](https://github.com/invertase/docs.page/pull/359)) +- `check` — validate `docs.json` and internal links + +### Locales + +- Multi-language documentation via locale-keyed `sidebar` in `docs.json` — use ISO language codes (`en`, `fr`, etc.) instead of a flat sidebar array ([#359](https://github.com/invertase/docs.page/pull/359)) +- Automatic language switcher in the documentation UI when multiple locales are configured +- Locale-prefixed URLs at `https://docs.page/{owner}/{repo}/{locale}/...` +- Per-locale sidebar navigation; internal links resolve relative to the active locale +- Optional `default` sidebar for the root page, or redirect to a default locale via frontmatter + +### Analytics + +- Google Tag Manager and Google Analytics via `docs.json` ([#211](https://github.com/invertase/docs.page/pull/211)) +- Plausible analytics support ([#233](https://github.com/invertase/docs.page/pull/233)) + +--- + +## Bug Fixes + +- Fix hydration state on client-side navigation ([#419](https://github.com/invertase/docs.page/issues/419)) +- Open internal sidebar links in the same tab ([#417](https://github.com/invertase/docs.page/pull/417)) +- Improve grouped sidebar collapse behaviour ([#399](https://github.com/invertase/docs.page/issues/399)) +- Respect `showPageImage` when rendering pages ([#420](https://github.com/invertase/docs.page/issues/420)) +- Treat frontmatter `false` as false ([#396](https://github.com/invertase/docs.page/issues/396)) +- Shiki CSS variables for code blocks ([#338](https://github.com/invertase/docs.page/pull/338)) +- Component navigation links ([#346](https://github.com/invertase/docs.page/pull/346)) +- Back button and error page handling ([#337](https://github.com/invertase/docs.page/pull/337)) +- Image zoom (RMIZ) stylesheet bundling ([#379](https://github.com/invertase/docs.page/issues/379)) +- Vanity domain redirect handling ([#363](https://github.com/invertase/docs.page/pull/363)) +- Redirect path and domain URL priority ([`390da36`](https://github.com/invertase/docs.page/commit/390da36)) +- Non-Latin URL encoding ([`17d9197`](https://github.com/invertase/docs.page/commit/17d9197)) +- Long sidebar title ellipsis ([`de11419`](https://github.com/invertase/docs.page/commit/de11419)) +- `init` command reliability in some environments (CLI 1.0.4) + +--- + +## Improvements + +- 2024 UI refresh and platform rework ([#359](https://github.com/invertase/docs.page/pull/359)) +- Split `website/` (Remix rendering) and `api/` (Express bundling) deployables ([`f862c15`](https://github.com/invertase/docs.page/commit/f862c15)) +- Express-based markdown bundling with remark/rehype validation ([`6126288`](https://github.com/invertase/docs.page/commit/6126288)) +- Move OG image generation into the website app ([`a275ff9`](https://github.com/invertase/docs.page/commit/a275ff9)) +- Defer GTM/GA initialization until after page load ([`9a05df6`](https://github.com/invertase/docs.page/commit/9a05df6)) +- Sidebar group heading icons and external link icons ([`5d80271`](https://github.com/invertase/docs.page/commit/5d80271)) +- FontAwesome 6.7.2 ([`304b62f`](https://github.com/invertase/docs.page/commit/304b62f)) +- Improved API and error page messaging ([#336](https://github.com/invertase/docs.page/pull/336)) +- Mobile header and layout polish ([`14ccd40`](https://github.com/invertase/docs.page/commit/14ccd40)) +- Middleware block list for unwanted paths ([`ff9ecef`](https://github.com/invertase/docs.page/commit/ff9ecef)) diff --git a/docs/releases/v2.0.0.mdx b/docs/releases/v2.0.0.mdx new file mode 100644 index 00000000..e020ffc2 --- /dev/null +++ b/docs/releases/v2.0.0.mdx @@ -0,0 +1,91 @@ +--- +title: Release notes — v2.0.0 +description: Unified Next.js platform, agent-ready docs, shared MDX pipeline, and CLI preview. +--- + +# Release notes — v2.0.0 + +**Release date:** 29-06-2026 (platform on `main` via [#488](https://github.com/invertase/docs.page/pull/488); `@docs.page/cli` [2.0.0](https://github.com/invertase/docs.page/releases/tag/cli-v2.0.0) on npm 2026-06-23) + +docs.page **2.0.0** replaces the 1.0.0 stack with a single Next.js application, shared markdown bundler, and agent-facing surfaces (MCP, `llms.txt`, Ask AI). + +**See also:** [CHANGELOG](../../CHANGELOG.md#200---2026-06-29) · [v1.0.0 release notes](./v1.0.0.mdx) + +--- + +## New Features + +### Built-in search + +- Built-in FlexSearch `search.json` on every site — no third-party widget, API key, or `docs.json` search config; replaces optional Algolia DocSearch ([`76eaf1a`](https://github.com/invertase/docs.page/commit/76eaf1a)) +- ⌘K command palette with in-page lookup and title-only mode (`>` prefix) ([`964f566`](https://github.com/invertase/docs.page/commit/964f566), [`12148bc`](https://github.com/invertase/docs.page/commit/12148bc)) + +### Documentation experience + +- **shadcn/ui theme presets** — named presets beyond v1 hex colour theming ([`0cb7003`](https://github.com/invertase/docs.page/commit/0cb7003), [`f7b97d7`](https://github.com/invertase/docs.page/commit/f7b97d7)) +- **Mermaid** diagrams in MDX ([`de3b9e3`](https://github.com/invertase/docs.page/commit/de3b9e3)) +- **Site banner** via `docs.json` ([`54479dd`](https://github.com/invertase/docs.page/commit/54479dd)) +- **`sitemap.xml`** and **`robots.txt`** per site ([`02fa436`](https://github.com/invertase/docs.page/commit/02fa436), [`65f5d45`](https://github.com/invertase/docs.page/commit/65f5d45)) +- Reworked documentation; v1 MDX components ported to the shared IR renderer ([`f938182`](https://github.com/invertase/docs.page/commit/f938182)) + +### Agent-ready documentation + +- **Ask AI** — in-site assistant with configurable suggested questions ([`4cac172`](https://github.com/invertase/docs.page/commit/4cac172), [`8dc1819`](https://github.com/invertase/docs.page/commit/8dc1819)) +- **MCP** — HTTP endpoint per site with `read_doc_page` and `list_doc_files` tools; repository `skills/` exposed as resources; install dialog with Cursor and VS Code deeplinks ([`75c1ab2`](https://github.com/invertase/docs.page/commit/75c1ab2), [`d1728bf`](https://github.com/invertase/docs.page/commit/d1728bf)); disable via `mcp.enabled` ([`1ac2f95`](https://github.com/invertase/docs.page/commit/1ac2f95)) +- **`docs.json` `agent` block** — API key, placeholder, starter questions, and rate limits ([`9d711f4`](https://github.com/invertase/docs.page/commit/9d711f4), [`cf39bb3`](https://github.com/invertase/docs.page/commit/cf39bb3)) +- **Agent page actions** — copy page as Markdown, open raw `.md` URL, Open in Claude, and MCP deeplinks ([`354770c`](https://github.com/invertase/docs.page/commit/354770c)) + +### LLM discovery + +- **`llms.txt`** and **`llms-full.txt`** — machine-readable doc index and expanded export ([`d88f7c4`](https://github.com/invertase/docs.page/commit/d88f7c4)) + +### CLI (`@docs.page/cli` 2.x) + +- **`preview`** — local live preview via the production bundler ([#472](https://github.com/invertase/docs.page/pull/472), [`5bcc76b`](https://github.com/invertase/docs.page/commit/5bcc76b)) +- **`agent create`** / **`agent delete`** — manage hosted agent credentials ([`6526298`](https://github.com/invertase/docs.page/commit/6526298)) +- **`check`** — extended with rendering validation ([`3faf391`](https://github.com/invertase/docs.page/commit/3faf391)) + +--- + +## Bug Fixes + +- Fix raw Markdown (`.md`) URL in the page action menu on custom domains and vanity subdomains ([`38bcb19`](https://github.com/invertase/docs.page/commit/38bcb19)) +- Fix Font Awesome icons rendering oversized in markdown headings ([`ba2808b`](https://github.com/invertase/docs.page/commit/ba2808b)) +- Fix images inside HTML tables using the shared markdown and image pipeline ([`aa8813c`](https://github.com/invertase/docs.page/commit/aa8813c)) +- Fix homepage marketing embed preview pointing at production docs instead of a stale branch preview ([`3bb8960`](https://github.com/invertase/docs.page/commit/3bb8960)) +- Regressions fixed during the v2 port (also present in late v1): hydration ([#419](https://github.com/invertase/docs.page/issues/419)), sidebar links ([#417](https://github.com/invertase/docs.page/pull/417), [#399](https://github.com/invertase/docs.page/issues/399)), `showPageImage` / frontmatter ([#420](https://github.com/invertase/docs.page/issues/420), [#396](https://github.com/invertase/docs.page/issues/396)), steps spacing ([`abf12a3`](https://github.com/invertase/docs.page/commit/abf12a3)) +- Fix CLI local preview rendering ([#472](https://github.com/invertase/docs.page/pull/472), [`5bcc76b`](https://github.com/invertase/docs.page/commit/5bcc76b), [`402d187`](https://github.com/invertase/docs.page/commit/402d187)) +- Improve markdown parsing for preview and production parity ([`202ab7e`](https://github.com/invertase/docs.page/commit/202ab7e)) +- Skip analytics scripts in local preview mode ([`c8d885f`](https://github.com/invertase/docs.page/commit/c8d885f)) +- Hide ref badge in local preview mode ([`e26ea34`](https://github.com/invertase/docs.page/commit/e26ea34)) +- Fix MCP endpoint URL and copy actions ([`5fc5e5e`](https://github.com/invertase/docs.page/commit/5fc5e5e)) +- Serve correct `search.json`, sitemap, `llms.txt`, and MCP URLs on custom domains ([`5593ebb`](https://github.com/invertase/docs.page/commit/5593ebb), [`25e3b7a`](https://github.com/invertase/docs.page/commit/25e3b7a)) +- Register GitHub webhook listener once per process ([`5340652`](https://github.com/invertase/docs.page/commit/5340652)) + +--- + +## Improvements + +### Documentation experience + +- Rework Open Graph image generation ([`a6e43d6`](https://github.com/invertase/docs.page/commit/a6e43d6)) +- Add canonical URL metadata ([`c06728d`](https://github.com/invertase/docs.page/commit/c06728d)) +- Consolidate v1 Edit control into the page action menu +- Improve agent chat UX ([`5572342`](https://github.com/invertase/docs.page/commit/5572342), [`c413ceb`](https://github.com/invertase/docs.page/commit/c413ceb)) +- Make headings clickable and improve card link affordance ([`f8692c1`](https://github.com/invertase/docs.page/commit/f8692c1), [`fb4a1f0`](https://github.com/invertase/docs.page/commit/fb4a1f0)) +- Align code fence and fenced block styling ([`ffb7a1a`](https://github.com/invertase/docs.page/commit/ffb7a1a)) + +### Other + +- Rework homepage ([`fcb095a`](https://github.com/invertase/docs.page/commit/fcb095a)) +- Footer UTM tags on outbound links ([`4ceae54`](https://github.com/invertase/docs.page/commit/4ceae54)) +- Streamdown-based markdown rendering ([`5a0863f`](https://github.com/invertase/docs.page/commit/5a0863f)) +- Tweet component `X` alias ([`c7cad53`](https://github.com/invertase/docs.page/commit/c7cad53)) + +### Platform rewrite + +- Single Next.js `app/` replaces `website/` and `api/` ([#470](https://github.com/invertase/docs.page/pull/470), [`a546632`](https://github.com/invertase/docs.page/commit/a546632)) +- Shared `packages/mdx-bundler` IR pipeline for hosted docs and CLI preview parity ([`be18d1d`](https://github.com/invertase/docs.page/commit/be18d1d), [#472](https://github.com/invertase/docs.page/pull/472)) +- Maintain v1 `docs.json` compatibility — automatic migration for legacy theme strings and `noindex` ([`94fd1f8`](https://github.com/invertase/docs.page/commit/94fd1f8)) +- Improve GitHub file resolution via jsDelivr ([`16405d3`](https://github.com/invertase/docs.page/commit/16405d3)) +- Relocate GitHub webhook handling into `app/` ([`aa5a7aa`](https://github.com/invertase/docs.page/commit/aa5a7aa)) From 4be237a1f25c4c455afbd20f3c293b4cbe3efa1f Mon Sep 17 00:00:00 2001 From: Alex Duke Date: Fri, 3 Jul 2026 10:38:08 +0100 Subject: [PATCH 2/2] Update v1/v2 changelog and release notes for PR #483. Align dates and homepage feature order, drop upgrade steps and media, record v2 bug fixes from closed issues, and move redirects out of net-new features. Co-authored-by: Cursor --- CHANGELOG.md | 34 +++++++++++++--- docs/releases/v1.0.0.mdx | 5 ++- docs/releases/v2.0.0.mdx | 83 ++++++++++++++++++++++++++-------------- 3 files changed, 86 insertions(+), 36 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a5bed961..6e3f0675 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,12 +2,12 @@ Platform changes to docs.page. Release notes: [2.0.0](./docs/releases/v2.0.0.mdx) · [1.0.0](./docs/releases/v1.0.0.mdx). -## [2.0.0] - 2026-06-23 +## [2.0.0] - 03-07-2026 ### Removed - **Breaking:** remove standalone `website/` and `api/` deployables ([#470](https://github.com/invertase/docs.page/pull/470)) -- **Breaking:** remove Algolia DocSearch integration — use built-in FlexSearch `search.json` instead +- Remove Algolia DocSearch integration — built-in FlexSearch `search.json` replaces optional third-party search ([`76eaf1a`](https://github.com/invertase/docs.page/commit/76eaf1a)) - Remove Redis-backed bundle cache in favour of surrogate cache control ([`0228337`](https://github.com/invertase/docs.page/commit/0228337)) ### Added @@ -18,15 +18,20 @@ Platform changes to docs.page. Release notes: [2.0.0](./docs/releases/v2.0.0.mdx - Add page action menu: copy Markdown, view `.md`, Open in Claude, and MCP deeplinks ([`354770c`](https://github.com/invertase/docs.page/commit/354770c)) - Add `llms.txt` and `llms-full.txt` endpoints ([`d88f7c4`](https://github.com/invertase/docs.page/commit/d88f7c4)) - Add Ask AI agent panel and configurable agent questions in `docs.json` ([`4cac172`](https://github.com/invertase/docs.page/commit/4cac172), [`8dc1819`](https://github.com/invertase/docs.page/commit/8dc1819)) +- Add Ask AI backend providers for OpenAI, Anthropic, Google, and xAI ([#490](https://github.com/invertase/docs.page/pull/490)) - Add command palette with tab navigation, Ask AI, and MCP shortcuts ([`964f566`](https://github.com/invertase/docs.page/commit/964f566), [`12148bc`](https://github.com/invertase/docs.page/commit/12148bc)) - Add in-page FlexSearch with title-only mode ([`964f566`](https://github.com/invertase/docs.page/commit/964f566)) - Add FlexSearch-backed `search.json` per repository ([`76eaf1a`](https://github.com/invertase/docs.page/commit/76eaf1a)) - Add `sitemap.xml` and `robots.txt` routes per repository ([`02fa436`](https://github.com/invertase/docs.page/commit/02fa436), [`65f5d45`](https://github.com/invertase/docs.page/commit/65f5d45)) - Add Mermaid diagram rendering in MDX ([`de3b9e3`](https://github.com/invertase/docs.page/commit/de3b9e3)) +- Add GitHub alert blockquote syntax for callouts ([#405](https://github.com/invertase/docs.page/issues/405)) - Add optional site banner in `docs.json` ([`54479dd`](https://github.com/invertase/docs.page/commit/54479dd)) - Add shadcn/ui preset themes and reworked documentation chrome ([`0cb7003`](https://github.com/invertase/docs.page/commit/0cb7003), [`f7b97d7`](https://github.com/invertase/docs.page/commit/f7b97d7)) - Add CLI `preview` and `agent` commands sharing the production bundler ([#472](https://github.com/invertase/docs.page/pull/472), [#470](https://github.com/invertase/docs.page/pull/470)) - Add configurable agent rate limiting ([`cf39bb3`](https://github.com/invertase/docs.page/commit/cf39bb3)) +- Add config-driven page redirects via frontmatter `redirect` ([#503](https://github.com/invertase/docs.page/pull/503)) +- Add Privacy Policy and Terms of Service pages ([#506](https://github.com/invertase/docs.page/pull/506)) +- Add server-side PostHog analytics for platform telemetry ([#492](https://github.com/invertase/docs.page/pull/492)) ### Changed @@ -39,10 +44,19 @@ Platform changes to docs.page. Release notes: [2.0.0](./docs/releases/v2.0.0.mdx - Relocate GitHub webhook handling into `app/` ([`aa5a7aa`](https://github.com/invertase/docs.page/commit/aa5a7aa)) - Rework Open Graph image generation ([`a6e43d6`](https://github.com/invertase/docs.page/commit/a6e43d6)) - Extend CLI `check` with rendering validation ([`3faf391`](https://github.com/invertase/docs.page/commit/3faf391)) +- Rewrite public product documentation ([#504](https://github.com/invertase/docs.page/pull/504)) +- Add Privacy and Terms links to site footers ([#510](https://github.com/invertase/docs.page/pull/510)) ### Fixed -- Register GitHub webhook listener once per process ([`5340652`](https://github.com/invertase/docs.page/commit/5340652)) +- Fix global variable substitution inside MDX components and fenced code blocks ([#324](https://github.com/invertase/docs.page/issues/324), [#436](https://github.com/invertase/docs.page/issues/436)) +- Fix sidebar disappearing when `logo` is a plain string in `docs.json` ([#394](https://github.com/invertase/docs.page/issues/394)) +- Fix locale switcher replacing the locale segment in URLs ([#370](https://github.com/invertase/docs.page/issues/370)) +- Fix sidebar item selection under tabbed navigation ([#414](https://github.com/invertase/docs.page/issues/414)) +- Fix sidebar tabs not updating after in-site redirect navigation ([#462](https://github.com/invertase/docs.page/issues/462), [`978f318`](https://github.com/invertase/docs.page/commit/978f318)) +- Fix GFM tables inside `Steps` components ([#484](https://github.com/invertase/docs.page/issues/484)) +- Fix extra line breaks when copying a partial code block selection ([#487](https://github.com/invertase/docs.page/issues/487), [`0a2ba19`](https://github.com/invertase/docs.page/commit/0a2ba19)) +- Register GitHub webhook listener once per process ([#475](https://github.com/invertase/docs.page/issues/475), [`5340652`](https://github.com/invertase/docs.page/commit/5340652)) - Serve correct `search.json`, sitemap, and `llms.txt` URLs on custom domains ([`5593ebb`](https://github.com/invertase/docs.page/commit/5593ebb), [`25e3b7a`](https://github.com/invertase/docs.page/commit/25e3b7a)) - Add canonical URLs and Open Graph metadata for documentation pages ([`c06728d`](https://github.com/invertase/docs.page/commit/c06728d)) - Fix MCP endpoint URL and copy actions ([`5fc5e5e`](https://github.com/invertase/docs.page/commit/5fc5e5e)) @@ -50,18 +64,26 @@ Platform changes to docs.page. Release notes: [2.0.0](./docs/releases/v2.0.0.mdx - Fix client navigation hydration handling ([#419](https://github.com/invertase/docs.page/issues/419)) - Prevent internal sidebar links from opening in a new tab ([#417](https://github.com/invertase/docs.page/pull/417)) - Improve grouped sidebar collapse, text wrapping, and mobile menu behaviour ([#399](https://github.com/invertase/docs.page/issues/399), [`d21f8ad`](https://github.com/invertase/docs.page/commit/d21f8ad)) +- Fix sidebar tab highlighting with multiple navigation tabs ([#411](https://github.com/invertase/docs.page/issues/411)) +- Hide page title when `showPageTitle` is disabled ([#428](https://github.com/invertase/docs.page/issues/428)) +- Post GitHub App PR preview comments only when documentation files change ([#287](https://github.com/invertase/docs.page/issues/287), [#491](https://github.com/invertase/docs.page/pull/491)) - Align code fence and fenced block styling ([`ffb7a1a`](https://github.com/invertase/docs.page/commit/ffb7a1a)) - Make headings clickable and improve card link affordance ([`f8692c1`](https://github.com/invertase/docs.page/commit/f8692c1), [`fb4a1f0`](https://github.com/invertase/docs.page/commit/fb4a1f0)) - Fix steps component spacing and nested children ([`abf12a3`](https://github.com/invertase/docs.page/commit/abf12a3), [`aa8bfbc`](https://github.com/invertase/docs.page/commit/aa8bfbc)) -- Fix CLI local preview rendering via shared production bundler ([#472](https://github.com/invertase/docs.page/pull/472), [`5bcc76b`](https://github.com/invertase/docs.page/commit/5bcc76b)) +- Fix CLI local preview rendering ([#472](https://github.com/invertase/docs.page/pull/472), [#429](https://github.com/invertase/docs.page/issues/429), [#433](https://github.com/invertase/docs.page/issues/433), [`5bcc76b`](https://github.com/invertase/docs.page/commit/5bcc76b)) - Fix preview page WebSocket client and doc rendering ([`402d187`](https://github.com/invertase/docs.page/commit/402d187)) - Skip analytics scripts in local preview mode ([`c8d885f`](https://github.com/invertase/docs.page/commit/c8d885f)) - Hide ref badge in local preview mode ([`e26ea34`](https://github.com/invertase/docs.page/commit/e26ea34)) - Improve markdown parsing for preview and production parity ([`202ab7e`](https://github.com/invertase/docs.page/commit/202ab7e)) +- Fix raw Markdown (`.md`) URL in the page action menu on custom domains and vanity subdomains ([`38bcb19`](https://github.com/invertase/docs.page/commit/38bcb19)) +- Fix Font Awesome icons rendering oversized in markdown headings ([`ba2808b`](https://github.com/invertase/docs.page/commit/ba2808b)) +- Fix images inside HTML tables using the shared markdown and image pipeline ([`aa8813c`](https://github.com/invertase/docs.page/commit/aa8813c)) +- Allow code group titles to scroll horizontally without clipping ([`24f0318`](https://github.com/invertase/docs.page/commit/24f0318)) +- Include `$schema` in CLI `init` scaffold output ([`de6ccff`](https://github.com/invertase/docs.page/commit/de6ccff)) [2.0.0]: https://github.com/invertase/docs.page/releases/tag/cli-v2.0.0 -## [1.0.0] - 2024-08-29 +## [1.0.0] - 29-08-2024 ### Added @@ -80,7 +102,7 @@ Platform changes to docs.page. Release notes: [2.0.0](./docs/releases/v2.0.0.mdx - Expose `docs.json` JSON Schema at `/schema.json` - Bundle markdown through Express API with remark/rehype validation plugins ([`6126288`](https://github.com/invertase/docs.page/commit/6126288)) - Support HTML comments and math in MDX ([#205](https://github.com/invertase/docs.page/pull/205)) -- Load custom domain routing from a remote domains list ([`46ec893`](https://github.com/invertase/docs.page/commit/46ec893)) +- Support platform-managed custom domain routing ([`46ec893`](https://github.com/invertase/docs.page/commit/46ec893)) - Add middleware block list for unwanted request paths ([`ff9ecef`](https://github.com/invertase/docs.page/commit/ff9ecef)) - Support sidebar group heading icons and external link icons ([`5d80271`](https://github.com/invertase/docs.page/commit/5d80271), [`ebc272c`](https://github.com/invertase/docs.page/commit/ebc272c)) - Upgrade FontAwesome icons to 6.7.2 ([`304b62f`](https://github.com/invertase/docs.page/commit/304b62f)) diff --git a/docs/releases/v1.0.0.mdx b/docs/releases/v1.0.0.mdx index 048b2c16..04805043 100644 --- a/docs/releases/v1.0.0.mdx +++ b/docs/releases/v1.0.0.mdx @@ -5,11 +5,13 @@ description: Instant, zero-configuration docs from public GitHub — the docs-as # Release notes — v1.0.0 +**Release date:** 29-08-2024 + **Ship documentation, like you ship code.** docs.page **1.0.0** is the docs-as-code platform for open-source developers: publish beautiful documentation instantly from markdown in a public GitHub repository, with zero configuration. Content is sourced directly from GitHub — no build pipelines, hosting setup, or website maintenance. -**See also:** [CHANGELOG](../../CHANGELOG.md#100---2024-08-29) +**See also:** [CHANGELOG](../../CHANGELOG.md#100---29-08-2024) --- @@ -24,6 +26,7 @@ docs.page **1.0.0** is the docs-as-code platform for open-source developers: pub - Global variables, per-page frontmatter, redirects, and previous/next page links ([#216](https://github.com/invertase/docs.page/pull/216)) - Dark and light themes with Shiki syntax highlighting - Vanity URLs at `{owner}.docs.page/{repo}` when the subdomain matches your GitHub owner or username, with no extra configuration +- Custom domains via platform-managed hostname mapping (request through docs.page — not configured in `docs.json`) ([#271](https://github.com/invertase/docs.page/pull/271)) - Static assets alongside documentation in the repository - JSON Schema for `docs.json` at `/schema.json` diff --git a/docs/releases/v2.0.0.mdx b/docs/releases/v2.0.0.mdx index e020ffc2..392bf1dd 100644 --- a/docs/releases/v2.0.0.mdx +++ b/docs/releases/v2.0.0.mdx @@ -3,64 +3,94 @@ title: Release notes — v2.0.0 description: Unified Next.js platform, agent-ready docs, shared MDX pipeline, and CLI preview. --- -# Release notes — v2.0.0 - -**Release date:** 29-06-2026 (platform on `main` via [#488](https://github.com/invertase/docs.page/pull/488); `@docs.page/cli` [2.0.0](https://github.com/invertase/docs.page/releases/tag/cli-v2.0.0) on npm 2026-06-23) +**Release date:** 03-07-2026 · `@docs.page/cli` [2.0.0](https://github.com/invertase/docs.page/releases/tag/cli-v2.0.0) on npm from 23-06-2026 docs.page **2.0.0** replaces the 1.0.0 stack with a single Next.js application, shared markdown bundler, and agent-facing surfaces (MCP, `llms.txt`, Ask AI). -**See also:** [CHANGELOG](../../CHANGELOG.md#200---2026-06-29) · [v1.0.0 release notes](./v1.0.0.mdx) +**See also:** [CHANGELOG](../../CHANGELOG.md#200---03-07-2026) · [v1.0.0 release notes](./v1.0.0.mdx) + +--- + +## Breaking Changes + +- Remove the 1.0.0 `website/` and `api/` packages — hosting, bundling, webhooks, and metadata routes live in `app/` ([#470](https://github.com/invertase/docs.page/pull/470)) +- Change CLI distribution to Bun-built `@docs.page/cli` 2.x ([#470](https://github.com/invertase/docs.page/pull/470)) +- Remove Redis-backed bundle cache in favour of surrogate cache control ([`0228337`](https://github.com/invertase/docs.page/commit/0228337)) --- ## New Features -### Built-in search +### Agent-ready -- Built-in FlexSearch `search.json` on every site — no third-party widget, API key, or `docs.json` search config; replaces optional Algolia DocSearch ([`76eaf1a`](https://github.com/invertase/docs.page/commit/76eaf1a)) -- ⌘K command palette with in-page lookup and title-only mode (`>` prefix) ([`964f566`](https://github.com/invertase/docs.page/commit/964f566), [`12148bc`](https://github.com/invertase/docs.page/commit/12148bc)) +- **Ask AI** — in-site assistant with configurable suggested questions; supports OpenAI, Anthropic, Google, and xAI providers via `docs agent create` ([#490](https://github.com/invertase/docs.page/pull/490), [`4cac172`](https://github.com/invertase/docs.page/commit/4cac172), [`8dc1819`](https://github.com/invertase/docs.page/commit/8dc1819)) +- **MCP** — HTTP endpoint per site with `read_doc_page` and `list_doc_files` tools; install dialog with Cursor, VS Code, Claude Code, and Antigravity deeplinks ([`75c1ab2`](https://github.com/invertase/docs.page/commit/75c1ab2), [`d1728bf`](https://github.com/invertase/docs.page/commit/d1728bf)); disable via `mcp.enabled: false` ([`1ac2f95`](https://github.com/invertase/docs.page/commit/1ac2f95)) +- **Agent skills** — `.agents/skills/**/SKILL.md` files in your repository exposed as MCP resources when MCP is enabled +- **`llms.txt`** and **`llms-full.txt`** — machine-readable doc index and expanded MDX export ([`d88f7c4`](https://github.com/invertase/docs.page/commit/d88f7c4)) +- **`docs.json` `agent` block** — API key, placeholder, starter questions, and per-IP / per-repo rate limits ([`9d711f4`](https://github.com/invertase/docs.page/commit/9d711f4), [`cf39bb3`](https://github.com/invertase/docs.page/commit/cf39bb3)) +- **Agent page actions** — copy page as Markdown, open raw `.md` URL, Open in Claude, and MCP deeplinks ([`354770c`](https://github.com/invertase/docs.page/commit/354770c)) -### Documentation experience +### Git publishing -- **shadcn/ui theme presets** — named presets beyond v1 hex colour theming ([`0cb7003`](https://github.com/invertase/docs.page/commit/0cb7003), [`f7b97d7`](https://github.com/invertase/docs.page/commit/f7b97d7)) -- **Mermaid** diagrams in MDX ([`de3b9e3`](https://github.com/invertase/docs.page/commit/de3b9e3)) -- **Site banner** via `docs.json` ([`54479dd`](https://github.com/invertase/docs.page/commit/54479dd)) -- **`sitemap.xml`** and **`robots.txt`** per site ([`02fa436`](https://github.com/invertase/docs.page/commit/02fa436), [`65f5d45`](https://github.com/invertase/docs.page/commit/65f5d45)) -- Reworked documentation; v1 MDX components ported to the shared IR renderer ([`f938182`](https://github.com/invertase/docs.page/commit/f938182)) +- Unified Next.js platform — hosting, bundling, webhooks, and metadata routes in a single `app/` deployable ([#470](https://github.com/invertase/docs.page/pull/470), [`a546632`](https://github.com/invertase/docs.page/commit/a546632)) +- Shared `packages/mdx-bundler` pipeline — hosted docs and CLI preview render through the same production bundler ([`be18d1d`](https://github.com/invertase/docs.page/commit/be18d1d), [#472](https://github.com/invertase/docs.page/pull/472)) +- Push-to-publish from public GitHub — no build pipelines, hosting configuration, or infrastructure maintenance +- Maintain v1 `docs.json` compatibility — automatic migration for legacy theme strings and `noindex` ([`94fd1f8`](https://github.com/invertase/docs.page/commit/94fd1f8)) +- Improve GitHub file resolution via jsDelivr ([`16405d3`](https://github.com/invertase/docs.page/commit/16405d3)) -### Agent-ready documentation +### Intelligent search -- **Ask AI** — in-site assistant with configurable suggested questions ([`4cac172`](https://github.com/invertase/docs.page/commit/4cac172), [`8dc1819`](https://github.com/invertase/docs.page/commit/8dc1819)) -- **MCP** — HTTP endpoint per site with `read_doc_page` and `list_doc_files` tools; repository `skills/` exposed as resources; install dialog with Cursor and VS Code deeplinks ([`75c1ab2`](https://github.com/invertase/docs.page/commit/75c1ab2), [`d1728bf`](https://github.com/invertase/docs.page/commit/d1728bf)); disable via `mcp.enabled` ([`1ac2f95`](https://github.com/invertase/docs.page/commit/1ac2f95)) -- **`docs.json` `agent` block** — API key, placeholder, starter questions, and rate limits ([`9d711f4`](https://github.com/invertase/docs.page/commit/9d711f4), [`cf39bb3`](https://github.com/invertase/docs.page/commit/cf39bb3)) -- **Agent page actions** — copy page as Markdown, open raw `.md` URL, Open in Claude, and MCP deeplinks ([`354770c`](https://github.com/invertase/docs.page/commit/354770c)) +- Built-in FlexSearch `search.json` on every site — no third-party widget, API key, or `docs.json` search config; replaces optional Algolia DocSearch ([`76eaf1a`](https://github.com/invertase/docs.page/commit/76eaf1a)) +- In-page FlexSearch with title-only mode (`>` prefix) ([`964f566`](https://github.com/invertase/docs.page/commit/964f566)) +- ⌘K command palette with in-page lookup, navigation tab shortcuts, **Ask AI**, and **Install MCP** entry points ([`964f566`](https://github.com/invertase/docs.page/commit/964f566), [`12148bc`](https://github.com/invertase/docs.page/commit/12148bc)) + +### Markdown components + +- Built-in MDX components — tabs, steps, callouts, code blocks, code groups, cards, accordion, property lists, headings, images, icons, and embeds (YouTube, Vimeo, Tweet / ``, video); no imports required ([#359](https://github.com/invertase/docs.page/pull/359), [`f938182`](https://github.com/invertase/docs.page/commit/f938182)) +- **Mermaid** diagrams in fenced code blocks ([`de3b9e3`](https://github.com/invertase/docs.page/commit/de3b9e3)) +- **GitHub alert syntax** — `> [!NOTE]`, `> [!WARNING]`, `> [!TIP]`, and `> [!CAUTION]` blockquotes render as Info, Warning, Success, and Error callouts ([#405](https://github.com/invertase/docs.page/issues/405)) +- Shared IR renderer — hosted sites and CLI `preview` use the same component map and bundler ([`be18d1d`](https://github.com/invertase/docs.page/commit/be18d1d), [#472](https://github.com/invertase/docs.page/pull/472)) -### LLM discovery +### Modern interface -- **`llms.txt`** and **`llms-full.txt`** — machine-readable doc index and expanded export ([`d88f7c4`](https://github.com/invertase/docs.page/commit/d88f7c4)) +- **shadcn/ui theme presets** — named presets beyond v1 hex colour theming, with reworked documentation chrome ([`0cb7003`](https://github.com/invertase/docs.page/commit/0cb7003), [`f7b97d7`](https://github.com/invertase/docs.page/commit/f7b97d7)) +- **Announcement banner** — site-wide strip via `docs.json` `banner` (`message`, optional `href`, `backgroundColor`, `foregroundColor`) ([`54479dd`](https://github.com/invertase/docs.page/commit/54479dd)) +- **`sitemap.xml`** and **`robots.txt`** per site ([`02fa436`](https://github.com/invertase/docs.page/commit/02fa436), [`65f5d45`](https://github.com/invertase/docs.page/commit/65f5d45)) ### CLI (`@docs.page/cli` 2.x) - **`preview`** — local live preview via the production bundler ([#472](https://github.com/invertase/docs.page/pull/472), [`5bcc76b`](https://github.com/invertase/docs.page/commit/5bcc76b)) - **`agent create`** / **`agent delete`** — manage hosted agent credentials ([`6526298`](https://github.com/invertase/docs.page/commit/6526298)) - **`check`** — extended with rendering validation ([`3faf391`](https://github.com/invertase/docs.page/commit/3faf391)) +- **`init`** — scaffolds `docs.json` with `$schema` for editor validation ([`de6ccff`](https://github.com/invertase/docs.page/commit/de6ccff)) --- ## Bug Fixes +- Fix global variable substitution inside MDX components and fenced code blocks ([#324](https://github.com/invertase/docs.page/issues/324), [#436](https://github.com/invertase/docs.page/issues/436)) +- Fix sidebar disappearing when `logo` is a plain string in `docs.json` ([#394](https://github.com/invertase/docs.page/issues/394)) +- Fix locale switcher replacing the locale segment in URLs (e.g. `/en/page` → `/fr/page`) ([#370](https://github.com/invertase/docs.page/issues/370)) +- Fix sidebar item selection under tabbed navigation ([#414](https://github.com/invertase/docs.page/issues/414)) +- Fix sidebar tab highlighting when using multiple navigation tabs ([#411](https://github.com/invertase/docs.page/issues/411)) +- Fix sidebar tabs not updating after in-site redirect navigation ([#462](https://github.com/invertase/docs.page/issues/462), [`978f318`](https://github.com/invertase/docs.page/commit/978f318)) +- Fix GFM tables inside `Steps` components ([#484](https://github.com/invertase/docs.page/issues/484)) +- Fix extra line breaks when copying a partial code block selection ([#487](https://github.com/invertase/docs.page/issues/487), [`0a2ba19`](https://github.com/invertase/docs.page/commit/0a2ba19)) - Fix raw Markdown (`.md`) URL in the page action menu on custom domains and vanity subdomains ([`38bcb19`](https://github.com/invertase/docs.page/commit/38bcb19)) - Fix Font Awesome icons rendering oversized in markdown headings ([`ba2808b`](https://github.com/invertase/docs.page/commit/ba2808b)) - Fix images inside HTML tables using the shared markdown and image pipeline ([`aa8813c`](https://github.com/invertase/docs.page/commit/aa8813c)) - Fix homepage marketing embed preview pointing at production docs instead of a stale branch preview ([`3bb8960`](https://github.com/invertase/docs.page/commit/3bb8960)) +- Hide page title when `showPageTitle` is disabled in frontmatter ([#428](https://github.com/invertase/docs.page/issues/428)) +- GitHub App posts PR preview comments only when documentation files change ([#287](https://github.com/invertase/docs.page/issues/287), [#491](https://github.com/invertase/docs.page/pull/491)) +- Stop duplicate GitHub PR preview comments ([#475](https://github.com/invertase/docs.page/issues/475), [`5340652`](https://github.com/invertase/docs.page/commit/5340652)) +- Allow code group titles to scroll horizontally without clipping ([`24f0318`](https://github.com/invertase/docs.page/commit/24f0318)) - Regressions fixed during the v2 port (also present in late v1): hydration ([#419](https://github.com/invertase/docs.page/issues/419)), sidebar links ([#417](https://github.com/invertase/docs.page/pull/417), [#399](https://github.com/invertase/docs.page/issues/399)), `showPageImage` / frontmatter ([#420](https://github.com/invertase/docs.page/issues/420), [#396](https://github.com/invertase/docs.page/issues/396)), steps spacing ([`abf12a3`](https://github.com/invertase/docs.page/commit/abf12a3)) -- Fix CLI local preview rendering ([#472](https://github.com/invertase/docs.page/pull/472), [`5bcc76b`](https://github.com/invertase/docs.page/commit/5bcc76b), [`402d187`](https://github.com/invertase/docs.page/commit/402d187)) +- Fix CLI local preview rendering ([#472](https://github.com/invertase/docs.page/pull/472), [#429](https://github.com/invertase/docs.page/issues/429), [#433](https://github.com/invertase/docs.page/issues/433), [`5bcc76b`](https://github.com/invertase/docs.page/commit/5bcc76b), [`402d187`](https://github.com/invertase/docs.page/commit/402d187)) - Improve markdown parsing for preview and production parity ([`202ab7e`](https://github.com/invertase/docs.page/commit/202ab7e)) - Skip analytics scripts in local preview mode ([`c8d885f`](https://github.com/invertase/docs.page/commit/c8d885f)) - Hide ref badge in local preview mode ([`e26ea34`](https://github.com/invertase/docs.page/commit/e26ea34)) - Fix MCP endpoint URL and copy actions ([`5fc5e5e`](https://github.com/invertase/docs.page/commit/5fc5e5e)) - Serve correct `search.json`, sitemap, `llms.txt`, and MCP URLs on custom domains ([`5593ebb`](https://github.com/invertase/docs.page/commit/5593ebb), [`25e3b7a`](https://github.com/invertase/docs.page/commit/25e3b7a)) -- Register GitHub webhook listener once per process ([`5340652`](https://github.com/invertase/docs.page/commit/5340652)) --- @@ -68,12 +98,14 @@ docs.page **2.0.0** replaces the 1.0.0 stack with a single Next.js application, ### Documentation experience +- **Config-driven redirects** — `redirect` frontmatter on a stub page returns HTTP 307 across canonical, vanity, custom-domain, and branch-preview URLs ([#503](https://github.com/invertase/docs.page/pull/503)) - Rework Open Graph image generation ([`a6e43d6`](https://github.com/invertase/docs.page/commit/a6e43d6)) - Add canonical URL metadata ([`c06728d`](https://github.com/invertase/docs.page/commit/c06728d)) - Consolidate v1 Edit control into the page action menu - Improve agent chat UX ([`5572342`](https://github.com/invertase/docs.page/commit/5572342), [`c413ceb`](https://github.com/invertase/docs.page/commit/c413ceb)) - Make headings clickable and improve card link affordance ([`f8692c1`](https://github.com/invertase/docs.page/commit/f8692c1), [`fb4a1f0`](https://github.com/invertase/docs.page/commit/fb4a1f0)) - Align code fence and fenced block styling ([`ffb7a1a`](https://github.com/invertase/docs.page/commit/ffb7a1a)) +- Rewrite public product documentation ([#504](https://github.com/invertase/docs.page/pull/504)) ### Other @@ -81,11 +113,4 @@ docs.page **2.0.0** replaces the 1.0.0 stack with a single Next.js application, - Footer UTM tags on outbound links ([`4ceae54`](https://github.com/invertase/docs.page/commit/4ceae54)) - Streamdown-based markdown rendering ([`5a0863f`](https://github.com/invertase/docs.page/commit/5a0863f)) - Tweet component `X` alias ([`c7cad53`](https://github.com/invertase/docs.page/commit/c7cad53)) - -### Platform rewrite - -- Single Next.js `app/` replaces `website/` and `api/` ([#470](https://github.com/invertase/docs.page/pull/470), [`a546632`](https://github.com/invertase/docs.page/commit/a546632)) -- Shared `packages/mdx-bundler` IR pipeline for hosted docs and CLI preview parity ([`be18d1d`](https://github.com/invertase/docs.page/commit/be18d1d), [#472](https://github.com/invertase/docs.page/pull/472)) -- Maintain v1 `docs.json` compatibility — automatic migration for legacy theme strings and `noindex` ([`94fd1f8`](https://github.com/invertase/docs.page/commit/94fd1f8)) -- Improve GitHub file resolution via jsDelivr ([`16405d3`](https://github.com/invertase/docs.page/commit/16405d3)) - Relocate GitHub webhook handling into `app/` ([`aa5a7aa`](https://github.com/invertase/docs.page/commit/aa5a7aa))