Skip to content

Add schema-compliant automated settings rendering#2909

Open
theletterf wants to merge 3 commits intomainfrom
settings-renderer
Open

Add schema-compliant automated settings rendering#2909
theletterf wants to merge 3 commits intomainfrom
settings-renderer

Conversation

@theletterf
Copy link
Contributor

@theletterf theletterf commented Mar 16, 2026

Summary

  • implement the full settings schema model for automated settings, including nested settings, applies_to, metadata, and setting-level admonitions/examples
  • render settings as definition lists in HTML and definition-style blocks in LLM markdown, with inline applies-to output and inherited applies-to resolution
  • normalize legacy AsciiDoc [source,*] snippets in settings text to markdown fenced code blocks, and expand docs/examples/tests for the new schema behavior

Closes #760

Contributes to elastic/docs-content#5355

Test plan

  • dotnet test tests/Elastic.Markdown.Tests/Elastic.Markdown.Tests.csproj --filter \"FullyQualifiedName~SettingsInclusion\"
  • dotnet test tests/authoring/authoring.fsproj --filter \"FullyQualifiedName~settings directive\"
  • Manual validation on http://localhost:3000/syntax/automated_settings for nested setting tip/admonition rendering and no raw ::: artifacts

Made with Cursor

…finitions.

Implement the new automated settings schema across HTML and LLM output, normalize legacy [source,*] snippets to markdown fences, and expand docs/tests with comprehensive applies_to and nested-setting examples.

Co-authored-by: OpenAI Assistant <assistant@openai.com>
Made-with: Cursor
@github-actions
Copy link

🔍 Preview links for changed docs

@theletterf
Copy link
Contributor Author

@kilfoyle @florent-leborgne @bmorelli25 First attempt at rendering the new settings schema with nesting and applies_to support. Please stress test this thing. :)

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Request] Generate config settings docs

2 participants