Skip to content

Commit fdc0428

Browse files
chore: Add changelog and release notes for v1/v2 (#483)
1 parent ff7e740 commit fdc0428

3 files changed

Lines changed: 348 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
# Changelog
2+
3+
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).
4+
5+
## [2.0.0] - 03-07-2026
6+
7+
### Removed
8+
9+
- **Breaking:** remove standalone `website/` and `api/` deployables ([#488](https://github.com/invertase/docs.page/pull/488))
10+
- Remove Algolia DocSearch integration — built-in FlexSearch `search.json` replaces optional third-party search ([`76eaf1a`](https://github.com/invertase/docs.page/commit/76eaf1a))
11+
- Remove Redis-backed bundle cache in favour of surrogate cache control ([`0228337`](https://github.com/invertase/docs.page/commit/0228337))
12+
13+
### Added
14+
15+
- Add unified Next.js application for hosting, bundling, and API routes ([`a546632`](https://github.com/invertase/docs.page/commit/a546632))
16+
- Add shared `packages/mdx-bundler` document IR pipeline ([`be18d1d`](https://github.com/invertase/docs.page/commit/be18d1d))
17+
- 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))
18+
- Add page action menu: copy Markdown, view `.md`, Open in Claude, and MCP deeplinks ([`354770c`](https://github.com/invertase/docs.page/commit/354770c))
19+
- Add `llms.txt` and `llms-full.txt` endpoints ([`d88f7c4`](https://github.com/invertase/docs.page/commit/d88f7c4))
20+
- 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))
21+
- Add Ask AI backend providers for OpenAI, Anthropic, Google, and xAI ([#490](https://github.com/invertase/docs.page/pull/490))
22+
- 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))
23+
- Add in-page FlexSearch with title-only mode ([`964f566`](https://github.com/invertase/docs.page/commit/964f566))
24+
- Add FlexSearch-backed `search.json` per repository ([`76eaf1a`](https://github.com/invertase/docs.page/commit/76eaf1a))
25+
- 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))
26+
- Add Mermaid diagram rendering in MDX ([`de3b9e3`](https://github.com/invertase/docs.page/commit/de3b9e3))
27+
- Add GitHub alert blockquote syntax for callouts ([#405](https://github.com/invertase/docs.page/issues/405))
28+
- Add optional site banner in `docs.json` ([`54479dd`](https://github.com/invertase/docs.page/commit/54479dd))
29+
- 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))
30+
- 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))
31+
- Add configurable agent rate limiting ([`cf39bb3`](https://github.com/invertase/docs.page/commit/cf39bb3))
32+
- Add config-driven page redirects via frontmatter `redirect` ([#503](https://github.com/invertase/docs.page/pull/503))
33+
- Add Privacy Policy and Terms of Service pages ([#506](https://github.com/invertase/docs.page/pull/506))
34+
- Add server-side PostHog analytics for platform telemetry ([#492](https://github.com/invertase/docs.page/pull/492))
35+
36+
### Changed
37+
38+
- **Breaking:** move local development to Bun workspace (`cd app && bun dev`)
39+
- Rework `@docs.page/cli` on Bun with shared validation and rendering checks ([#470](https://github.com/invertase/docs.page/pull/470))
40+
- Serve `docs.json` schema from the Next.js app ([`88dec3a`](https://github.com/invertase/docs.page/commit/88dec3a))
41+
- 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))
42+
- Improve GitHub file resolution via jsDelivr ([`16405d3`](https://github.com/invertase/docs.page/commit/16405d3))
43+
- Maintain v1 `docs.json` compatibility during migration ([`94fd1f8`](https://github.com/invertase/docs.page/commit/94fd1f8))
44+
- Relocate GitHub webhook handling into `app/` ([`aa5a7aa`](https://github.com/invertase/docs.page/commit/aa5a7aa))
45+
- Rework Open Graph image generation ([`a6e43d6`](https://github.com/invertase/docs.page/commit/a6e43d6))
46+
- Extend CLI `check` with rendering validation ([`3faf391`](https://github.com/invertase/docs.page/commit/3faf391))
47+
- Rewrite public product documentation ([#504](https://github.com/invertase/docs.page/pull/504))
48+
- Add Privacy and Terms links to site footers ([#510](https://github.com/invertase/docs.page/pull/510))
49+
50+
### Fixed
51+
52+
- 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))
53+
- Fix sidebar disappearing when `logo` is a plain string in `docs.json` ([#394](https://github.com/invertase/docs.page/issues/394))
54+
- Fix locale switcher replacing the locale segment in URLs ([#370](https://github.com/invertase/docs.page/issues/370))
55+
- Fix sidebar item selection under tabbed navigation ([#414](https://github.com/invertase/docs.page/issues/414))
56+
- 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))
57+
- Fix GFM tables inside `Steps` components ([#484](https://github.com/invertase/docs.page/issues/484))
58+
- 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))
59+
- 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))
60+
- 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))
61+
- Add canonical URLs and Open Graph metadata for documentation pages ([`c06728d`](https://github.com/invertase/docs.page/commit/c06728d))
62+
- Fix MCP endpoint URL and copy actions ([`5fc5e5e`](https://github.com/invertase/docs.page/commit/5fc5e5e))
63+
- 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))
64+
- Fix sidebar tab highlighting with multiple navigation tabs ([#411](https://github.com/invertase/docs.page/issues/411))
65+
- Hide page title when `showPageTitle` is disabled ([#428](https://github.com/invertase/docs.page/issues/428))
66+
- 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))
67+
- Align code fence and fenced block styling ([`ffb7a1a`](https://github.com/invertase/docs.page/commit/ffb7a1a))
68+
- 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))
69+
- 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))
70+
- 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))
71+
- Fix preview page WebSocket client and doc rendering ([`402d187`](https://github.com/invertase/docs.page/commit/402d187))
72+
- Skip analytics scripts in local preview mode ([`c8d885f`](https://github.com/invertase/docs.page/commit/c8d885f))
73+
- Hide ref badge in local preview mode ([`e26ea34`](https://github.com/invertase/docs.page/commit/e26ea34))
74+
- Improve markdown parsing for preview and production parity ([`202ab7e`](https://github.com/invertase/docs.page/commit/202ab7e))
75+
- 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))
76+
- Fix Font Awesome icons rendering oversized in markdown headings ([`ba2808b`](https://github.com/invertase/docs.page/commit/ba2808b))
77+
- Fix images inside HTML tables using the shared markdown and image pipeline ([`aa8813c`](https://github.com/invertase/docs.page/commit/aa8813c))
78+
- Allow code group titles to scroll horizontally without clipping ([`24f0318`](https://github.com/invertase/docs.page/commit/24f0318))
79+
- Include `$schema` in CLI `init` scaffold output ([`de6ccff`](https://github.com/invertase/docs.page/commit/de6ccff))
80+
81+
[2.0.0]: https://github.com/invertase/docs.page/releases/tag/cli-v2.0.0
82+
83+
## [1.0.0]
84+
85+
### Added
86+
87+
- Publish documentation from public GitHub repositories with zero custom site setup ([#359](https://github.com/invertase/docs.page/pull/359))
88+
- Support `docs.json` for name, description, logo, favicon, theme, header, sidebar, tabs, anchors, and SEO
89+
- 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))
90+
- Render MDX with built-in components: tabs, steps, callouts, code blocks, code groups, cards, accordion, property, and headings
91+
- 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))
92+
- Provide live previews for branches, pull requests, and commits with hydration reload ([#340](https://github.com/invertase/docs.page/pull/340))
93+
- Install GitHub App webhooks for automatic pull request preview URLs
94+
- Support custom and vanity domains ([#271](https://github.com/invertase/docs.page/pull/271))
95+
- Support optional Algolia DocSearch integration
96+
- Generate Open Graph images for documentation pages ([`150d6da`](https://github.com/invertase/docs.page/commit/150d6da))
97+
- Support global variable injection, per-page frontmatter, redirects, and previous/next controls ([#216](https://github.com/invertase/docs.page/pull/216))
98+
- Support dark and light mode with syntax-highlighted code blocks
99+
- Expose `docs.json` JSON Schema at `/schema.json`
100+
- Bundle markdown through Express API with remark/rehype validation plugins ([`6126288`](https://github.com/invertase/docs.page/commit/6126288))
101+
- Support HTML comments and math in MDX ([#205](https://github.com/invertase/docs.page/pull/205))
102+
- Support platform-managed custom domain routing ([`46ec893`](https://github.com/invertase/docs.page/commit/46ec893))
103+
- Add middleware block list for unwanted request paths ([`ff9ecef`](https://github.com/invertase/docs.page/commit/ff9ecef))
104+
- 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))
105+
- Upgrade FontAwesome icons to 6.7.2 ([`304b62f`](https://github.com/invertase/docs.page/commit/304b62f))
106+
- Add `@docs.page/cli` with `init` and `check` commands ([#359](https://github.com/invertase/docs.page/pull/359))
107+
108+
### Changed
109+
110+
- Rework platform UI and architecture in the 2024 refresh ([#359](https://github.com/invertase/docs.page/pull/359))
111+
- Rename `website-v3/``website/` (Astro), separate from the `api/` bundling service ([`f862c15`](https://github.com/invertase/docs.page/commit/f862c15))
112+
- Move Open Graph image generation into the main website application ([`a275ff9`](https://github.com/invertase/docs.page/commit/a275ff9))
113+
- Initialize Google Tag Manager and Google Analytics after page load ([`9a05df6`](https://github.com/invertase/docs.page/commit/9a05df6))
114+
- Improve error pages and API error handling ([#336](https://github.com/invertase/docs.page/pull/336))
115+
116+
### Fixed
117+
118+
- Respect `showPageImage` when rendering pages ([#420](https://github.com/invertase/docs.page/issues/420))
119+
- Fix hydration state handling on client-side navigation ([#419](https://github.com/invertase/docs.page/issues/419))
120+
- Prevent non-external sidebar links from opening in a new tab ([#417](https://github.com/invertase/docs.page/pull/417))
121+
- Improve collapsing behaviour of grouped sidebar items ([#399](https://github.com/invertase/docs.page/issues/399))
122+
- Treat frontmatter `false` as false instead of falling back to defaults ([#396](https://github.com/invertase/docs.page/issues/396))
123+
- Handle vanity domain redirects ([#363](https://github.com/invertase/docs.page/pull/363))
124+
- 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))
125+
- Encode non-Latin characters in URLs ([`17d9197`](https://github.com/invertase/docs.page/commit/17d9197))
126+
- Truncate long sidebar titles with an ellipsis ([`de11419`](https://github.com/invertase/docs.page/commit/de11419))
127+
- Ensure image zoom (RMIZ) styles are bundled ([#379](https://github.com/invertase/docs.page/issues/379))
128+
- Fix Shiki CSS variable theming for code blocks ([#338](https://github.com/invertase/docs.page/pull/338))
129+
- Improve back navigation and error page messaging ([#337](https://github.com/invertase/docs.page/pull/337))
130+
- Fix component navigation links ([#346](https://github.com/invertase/docs.page/pull/346))
131+
- Hide SVG title elements in rendered output ([`02bf3f1`](https://github.com/invertase/docs.page/commit/02bf3f1))
132+
- Improve mobile header and layout styling ([`14ccd40`](https://github.com/invertase/docs.page/commit/14ccd40))
133+
- Fix spelling in documentation ([#416](https://github.com/invertase/docs.page/pull/416))
134+
135+
[1.0.0]: https://github.com/invertase/docs.page/releases

0 commit comments

Comments
 (0)