Repository navigation
0.42.0
Highlights
Machine-readable indexes
Two new artifacts for tools that read the documentation rather than browse it
(#1427):
toc.json, in every manual, is its table of contents: what pages there
are, in the order the toctree puts them and nested the way it nests them.
The project is stated once at the top, including the permalink pattern, so a
page carries only its own path, title and anchor. For TYPO3 Explained that is
348 KB againstobjects.inv.json's 4.2 MB.Changelog-<major>.json, in the Core Changelog only, lists the entries of
a release with permalink, file, title, kind of change, Forge issue and tags.
Markdown
- Changelog entries now describe themselves in their front matter —
typo3-version,typo3-major,type,issue,forgeandtags(#1421).
Note thatmodifiedis renamed torenderedin every manual: the value
was always the build time, identical on every page. - Headings carry the id their HTML counterpart has, written as
{#id}(#1422) - The whole manual can be rendered into one file with
--single-markdown,
for feeding a local language model (#1420)
Pages
- Every page now declares a
rel="canonical"— its permalink (#1428). The head
carried none at all, while…/13.4/en-us/and…/13.4/en-us/Index.htmlserve
the same bytes. - A page with a
:navigation-title:had a menu entry linking to#. In the
single-page HTML that was the whole link: 404 of them in the ViewHelper
reference alone (#1429) - The search scope select no longer breaks on a missing page header (#1408)
Authoring
:changelog:on the version-change directives links the related changelog
entry, with the entry's own title as the link text (#1303)- Permalinks the published route cannot resolve are now reported while
rendering, instead of 404-ing after deployment (#1425)
Contributing
AGENTS.mdrecords what a coding agent needs to know about this repository,
withCLAUDE.mdimporting it (#1430)
Plus eight dependency updates.
What's Changed
- [TASK]: Bump react-dom from 19.2.8 to 19.3.0 in /packages/typo3-docs-theme by @dependabot[bot] in #1416
- [TASK]: Bump @vitejs/plugin-react from 6.1.0 to 6.1.1 in /packages/typo3-docs-theme by @dependabot[bot] in #1419
- [TASK]: Bump ergebnis/composer-normalize from 2.52.0 to 2.53.0 by @dependabot[bot] in #1415
- [TASK]: Bump @stylistic/stylelint-plugin from 5.2.1 to 5.3.0 in /packages/typo3-docs-theme by @dependabot[bot] in #1417
- [FEATURE] Render the whole manual into one Markdown file by @linawolf in #1420
- [BUGFIX] Enqueue Dependabot PRs with an App token by @linawolf in #1399
- [TASK]: Bump sass from 1.104.0 to 1.104.1 in /packages/typo3-docs-theme by @dependabot[bot] in #1423
- [TASK]: Bump vite from 8.2.2 to 8.3.0 in /packages/typo3-docs-theme by @dependabot[bot] in #1424
- [FEATURE] Give Markdown headings the id the HTML heading has by @linawolf in #1422
- [FEATURE] Describe changelog entries in their Markdown front matter by @linawolf in #1421
- [BUGFIX] Guard the search scope select against a missing page header by @linawolf in #1408
- [TASK]: Bump phpstan/phpstan from 2.2.13 to 2.2.14 by @dependabot[bot] in #1426
- [FEATURE] Report permalinks the published route cannot resolve by @linawolf in #1425
- [FEATURE] Add :changelog: option to version change directives by @CybotTM in #1303
- [BUGFIX] Give a navigation title the anchor of the page it names by @linawolf in #1429
- [DOCS] Write down what an agent needs to know about this repository by @linawolf in #1430
- [FEATURE] Declare the permalink as the canonical URL of a page by @linawolf in #1428
- [FEATURE] Publish the table of contents and the changelog index as JSON by @linawolf in #1427
Full Changelog: 0.41.0...0.42.0