Repository navigation
Conversation
The nested toc.yml files in docs-content now declare `suppress:` themselves, so the temporary path list in `DocumentationSetFile` is dead weight. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Contributor
Docs preview (local build)Handbook preview: https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/4561/ |
The Windows build reports `solutions\toc.yml`, so the `EndsWith("solutions/toc.yml")` check failed there. The test now normalises backslashes before comparing.
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This branch was successfully deployed
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.
Merge after elastic/docs-content#8988 (open at the time of writing). That PR adds
suppress:to thedocs-contenttoc files this change stops special-casing.Part of https://github.com/elastic/docs-eng-team/issues/1115
Affects: Configuration, Assembler builds
Why
DocumentationSetFilecarries a temporary list ofdocs-contenttoc paths that always getDeepLinkingVirtualFilesuppressed, because those tocs did not declaresuppress:. The list hides the hint from every build, whatever the toc says. docs-builder consumesdocs-contentat build time, so merging this before the content PR brings back about 416 hints in assembler builds.What
Suppression comes only from the toc
The
skippath list and the check that used it are gone fromDocumentationSetFile. A nestedtoc.ymlsuppressesDeepLinkingVirtualFileonly when it declaressuppress:itself, which is how every other repo already works.OptionalWindowsReplacestays because other code uses it.Tests
Two tests in
ValidationTestsload a nested toc atdocs-content/solutions/toc.yml. Withoutsuppress:it reports the deep-linking hint. Withsuppress:it reports nothing.Verify
Restoring the old list makes
NestedToc_UnderFormerlyHardcodedPathWithoutSuppress_EmitsDeepLinkingHintfail.🤖 Generated with Claude Code