Repository navigation
docs: use folder entries for nested toc sections - #665
Merged
Merged
Conversation
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>
🔍 Preview links for changed docs⏳ Building and deploying preview... View progress This comment will be updated with preview links when the build is complete. |
✅ 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. |
Mpdreamz
marked this pull request as ready for review
October 22, 2026 15:09
xrmx
approved these changes
Oct 23, 2026
florent-leborgne
approved these changes
Oct 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rewrites 1 nested
toc.ymlentries asfolder:entries so docs-builder stops reporting theDeepLinkingVirtualFilehint, with no change to page URLs.Why
A
file:entry whose path contains/and that haschildren: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-python/toc.yml, eachfile: <dir>/index.mdentry withchildren:is nowfolder: <dir>. Itschildren:start withfile: index.mdand 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
docsdirectory:DeepLinkingVirtualFilehints: 1 before, 0 after.<out>/links.json: identical before and after.🤖 Generated with Claude Code