improvement(api-markdown-documenter): Update default suite configuration to leverage new hierarchy options #23602
+572
−509
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 default suite structure has been updated as follows:
-
Package
andNamespace
items now generate documents inside of their own folder hierarchy, yielding documents named "index".-
Enum
andTypeAlias
items now generate their own documents (rather than being rendered as sections under their parent document).E.g., old output would likely look something like
And the new output would likely look more like:
Updates to the
default-config
test assets demonstrate the difference.Also update the
spase-config
test suite to move the package documents under their own hierarchy to be more demonstrative of what an expected use case would likely look like. Other test cases have been updated to maintain existing behavior, accounting for the new defaults.AB#24263