Skip to content

Conversation

theletterf
Copy link
Contributor

@theletterf theletterf commented Aug 29, 2025

Fixes #1789

  • Adds more inline applies_to examples.
  • Adds more includes for cleaner editing.
  • Wraps all examples in dropdowns and tabs (when possible).
  • Tabbed the key-value reference.
  • Moved Syntax content to the Syntax section.

@theletterf theletterf requested review from a team as code owners August 29, 2025 09:13
@theletterf theletterf self-assigned this Aug 29, 2025
@theletterf theletterf added the documentation Improvements or additions to documentation label Aug 29, 2025
Copy link

github-actions bot commented Aug 29, 2025

Copy link
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

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

Nice! ✨ I left some questions, comments, and suggestions below.

theletterf and others added 2 commits August 30, 2025 11:27
Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
@theletterf
Copy link
Contributor Author

@colleenmcginnis Thanks! Changes applied.

Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
Comment on lines +87 to +93
A specialized `{preview}` role exists to quickly mark something as a technical preview. It takes a required version number
as an argument.

```markdown
Property {preview}`<version>`
: definition body
```
Copy link
Contributor

Choose a reason for hiding this comment

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

I like the shortened syntax but I'm wondering if we really want to encourage badges without product keys at this point. I see the benefit, I'm just concerned about output consistency

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was in the original version. I'm OK with removing it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.

Improve inline applies_to documentation
4 participants