Skip to content

docs: describe toc item names taken from article headings - #351

Merged
martyanovandrey merged 1 commit into
masterfrom
docs/toc-item-autoname
Sep 17, 2026
Merged

martyanovandrey merged 1 commit into
masterfrom
docs/toc-item-autoname

Conversation

@martyanovandrey

Copy link
Copy Markdown
Contributor

Description

The build fills a missing toc item name (or a name set to {#T}) from the first-level heading of the linked article, with includes followed and the file name as a fallback. This has worked since feat: Add autotitles to TOC in the CLI (April 2025) but was never documented: the toc.yaml reference presented name as a mandatory field.

Adds a "Section name from the article heading" subsection to the toc.yaml page in both languages, with a note on why it helps translations (such items are not translated in toc.yaml, each language gets its own heading) and a cross-link to the {#T} rule for links.

Related: DOCSTOOLS-6684.

@github-actions

Copy link
Copy Markdown

✅ Documentation build

Revision built successfully
Revision preview link

Build logs

Warnings (2)

⚠️ en/guides/openapi.md: 168: YFM001 / inline-code-length Inline code length [Expected: 100; Actual: 265] [Context: " — the specification is displayed directly on the page (default value). If the size of the specification's json schema exceeds the value of ##maxOpenapiIncludeSize## (100 KB by default), the mode automatically switches to "]

⚠️ en/tools/docs/build.md: 52: YFM001 / inline-code-length Inline code length [Expected: 100; Actual: 109] [Context: " — a snapshot of the dependency graph (pages, included files, assets, missing paths, edge count), as well as "]

@martyanovandrey
martyanovandrey merged commit 3051072 into master Sep 17, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant