Draft
Conversation
lcawl
commented
Mar 18, 2026
lcawl
commented
Mar 18, 2026
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
lcawl
commented
Mar 18, 2026
| navigation_title: docset.yml format | ||
| --- | ||
|
|
||
| # docset.yml file format |
Contributor
Author
There was a problem hiding this comment.
Suggested change
| # docset.yml file format | |
| # docset.yml |
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.
Summary
Add comprehensive documentation for the
docset.ymlfile format in the content-set configuration section, specifying which fields are required vs optional and their purposes.Context
The
docset.ymlfile (or_docset.yml) configures a content set's structure and metadata. Currently, documentation is scattered across navigation.md, building-blocks/documentation-set.md, and other pages. There is no single reference that lists all supported fields and their required/optional status. Theproductsfield, for example, is optional (defaults to empty) but this is not documented.I identified this gap when I was reviewing https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/syntax/changelog and trying to figure out what product ID defaults that were "auto from docset" were coming from.
Source of truth
The schema is defined in:
project,toc,suppressmax_toc_depth,dev_docs,cross_links,exclude,extensions,subs,display_name,description,icon,registry,features,api,products,codexproductsonly applied whenCount > 0)Implementation
Generative AI disclosure
Tool(s) and model(s) used: composer-1.5