Skip to content

docs: use folder entries for nested toc sections - #1286

Draft
Mpdreamz wants to merge 1 commit into
mainfrom
docs/folder-for-nested-toc
Draft

Mpdreamz wants to merge 1 commit into
mainfrom
docs/folder-for-nested-toc

Conversation

@Mpdreamz

Copy link
Copy Markdown
Member

Rewrites 1 nested toc.yml entries as folder: entries so docs-builder stops reporting the DeepLinkingVirtualFile hint, with no change to page URLs.

Why

A file: entry whose path contains / and that has children: makes docs-builder emit "uses deep-linking with children" hints. Part of https://github.com/elastic/docs-eng-team/issues/1115, which cuts diagnostic noise from assembler builds.

What

In docs/reference/edot-java/toc.yml, each file: <dir>/index.md entry with children: is now folder: <dir>. Its children: start with file: index.md and use paths relative to the folder. Order, nesting and titles are unchanged, and every Markdown file in each folder is still listed. No files move and no redirects are needed.

Verify

Isolated builds before and after, from the docs directory:

docs-builder build --path docs --output <out> --force --skip-cross-links
  • DeepLinkingVirtualFile hints: 1 before, 0 after.
  • <out>/links.json: identical before and after.
  • Warnings and errors: 0 before, 0 after. No other diagnostic changed.

🤖 Generated with Claude Code

Replace `file: <dir>/index.md` entries that have `children:` with `folder: <dir>` so docs-builder no longer emits the `DeepLinkingVirtualFile` hint. Page URLs are unchanged.

Part of elastic/docs-eng-team#1115

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

📋 Changelog

🏷️ Changelog label needed — add a type label so we can determine this PR's release-notes status.

🔖 Add one of these type labels to your PR: breaking-change, bug, deprecation, feature, enhancement, changelog:upstream-update, docs, documentation

⏭️ To exclude this PR from release notes, add one of these labels: changelog:skip

📄 Inspect the current changelog configuration.

@github-actions

Copy link
Copy Markdown

🔍 Preview links for changed docs

⏳ Building and deploying preview... View progress

This comment will be updated with preview links when the build is complete.

@github-actions

Copy link
Copy Markdown

✅ Elastic Docs Style Checker (Vale)

No issues found on modified lines!


The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.

This branch was successfully deployed

1 active deployment
docs-preview — 97e328b2 Deployed Oct 22, 2026 by github-actions[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant