跳到导航

Site-level changelog for multi-product sites

Multi-product sites can now have a single changelog shared by every product. Add a top-level changelog key in docs.yml next to products and the changelog is served at /changelog, without a product slug prefix and without appearing in the product switcher. This replaces the workaround of a dedicated “Changelog” product hidden with CSS.

docs.yml
products:
- display-name: Ferns
path: ./products/ferns.yml
- display-name: Cacti
path: ./products/cacti.yml
changelog:
changelog: ./changelog
Read the docs

Reference API specs directly from docs.yml

You can now point an api navigation item straight at your OpenAPI, AsyncAPI, or GraphQL specification files with a specs list, without creating a generators.yml. Each entry takes a type and a path (relative to the configuration file), plus optional overrides, overlays, and namespace. Existing api-name setups are unchanged.

docs.yml
navigation:
- api: API Reference
specs:
- type: openapi
path: ./openapi.yml
Read the docs