Skip to content

[DOCS] Add reference info for docset.yml#2915

Draft
lcawl wants to merge 2 commits intomainfrom
docset-docs
Draft

[DOCS] Add reference info for docset.yml#2915
lcawl wants to merge 2 commits intomainfrom
docset-docs

Conversation

@lcawl
Copy link
Contributor

@lcawl lcawl commented Mar 18, 2026

Summary

Add comprehensive documentation for the docset.yml file format in the content-set configuration section, specifying which fields are required vs optional and their purposes.

Context

The docset.yml file (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. The products field, 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:

  • TableOfContentsFile.cs – base fields: project, toc, suppress
  • DocumentationSetFile.cs – extended fields: max_toc_depth, dev_docs, cross_links, exclude, extensions, subs, display_name, description, icon, registry, features, api, products, codex
  • ConfigurationFile.cs – how fields are processed (e.g., products only applied when Count > 0)

Implementation

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No
  1. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.).

Tool(s) and model(s) used: composer-1.5

@github-actions
Copy link

github-actions bot commented Mar 18, 2026

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
navigation_title: docset.yml format
---

# docset.yml file format
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# docset.yml file format
# docset.yml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant