Repository navigation
Conversation
Nested toc.yml files accept suppress too, scoped to their own entries. The docs only covered docset.yml, and the XML comment on TableOfContentsFile.SuppressDiagnostics listed two of the three hint types. 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/4559/ Sample changed pages: |
| file: index.md | ||
| ``` | ||
|
|
||
| When you switch to `folder:` with `file: index.md` and no `children`, the folder picks up every Markdown file automatically. If you give the `folder:` explicit `children`, list every Markdown file in the folder, or the build fails with "is not listed in the table of contents" for each file you leave out. Moving the page to `folder:` can change its URL, so check the URLs before and after. |
There was a problem hiding this comment.
Severity: P3 (Low)
folder: with file: index.md does not auto-discover the other Markdown files, even when children is omitted. The YAML converter inserts the index as an explicit child, so folder resolution skips auto-discovery. Following this example in a multi-page folder therefore produces the same unlisted-page errors warned about here. Recommend a bare folder: for auto-discovery, or include the remaining pages as explicit children.
Generated by Libra. React with 👍 or 👎 to give feedback on this comment.
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.
The configure reference now says that nested
toc.ymlfiles acceptsuppress:too, how far it reaches, and when to restructure tofolder:instead.Affects: Configuration, Authoring
Prompt summary: Document that
suppress:is valid in nestedtoc.ymlfiles and not onlydocset.yml, with its scope and the three hint names, and fix the stale comment onTableOfContentsFile.SuppressDiagnostics. This supports the diagnostic-noise cleanup in https://github.com/elastic/docs-eng-team/issues/1115 (part of).Why
docs/documentation/isolated/configure/index.mddescribessuppress:fordocset.ymlonly, yetTableOfContentsFile.SuppressDiagnosticsreads it fromtoc.ymlas well. The XML comment on that property lists two of the threeHintTypevalues.What
Where
suppress:appliesThe docs now state that
suppress:is valid indocset.ymland in nestedtoc.ymlfiles. Atoc.ymllist covers only the entries in that file, and atoc.ymldoes not inherit thedocset.ymllist.AutolinkElasticCoDocsis raised during Markdown parsing, so it is only read fromdocset.yml.Preferring
folder:over suppressingThe
DeepLinkingVirtualFilesection recommendsfolder:withfile: index.md, and warns that afolder:with explicitchildrenmust list every Markdown file or the build fails with "is not listed in the table of contents". It also notes that the move can change URLs.XML comment
TableOfContentsFile.SuppressDiagnosticsnow lists all three hint types. This is a comment-only change. The hardcoded docs-content list inDocumentationSetFile.csis untouched.Verify
Scratch docset with
docset.yml(file: top/deep.mdwith children) and a nestedsub/toc.yml(file: other/x.mdwith children). Run:Without
suppress:, twouses deep-linking with childrenhints appear (other/x.mdandtop/deep.md). Withsuppress: [DeepLinkingVirtualFile]added tosub/toc.yml, only thetop/deep.mdhint remains.dotnet build src/Elastic.Documentation.Configurationsucceeds.🤖 Generated with Claude Code