Skip to content

Restructure doc and add inline examples #1793

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 17 commits into from
Sep 4, 2025
Merged

Restructure doc and add inline examples #1793

merged 17 commits into from
Sep 4, 2025

Conversation

@theletterf
Copy link
Contributor

@theletterf theletterf commented Aug 29, 2025 •
edited
Loading

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
@github-actions
Copy link

github-actions bot commented Aug 29, 2025 •
edited
Loading

🔍 Preview links for changed docs

colleenmcginnis
colleenmcginnis reviewed Aug 29, 2025
View reviewed changes
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
Copy link
Contributor Author

theletterf commented Aug 30, 2025

@colleenmcginnis Thanks! Changes applied.

@theletterf theletterf mentioned this pull request Sep 1, 2025
Closed
florent-leborgne
florent-leborgne reviewed Sep 1, 2025
View reviewed changes
florent-leborgne
florent-leborgne reviewed Sep 1, 2025
View reviewed changes
colleenmcginnis
colleenmcginnis approved these changes Sep 3, 2025
View reviewed changes
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.

Thanks @theletterf! I left a few minor comments/suggestions below for your consideration. 💁‍♀️

@theletterf theletterf merged commit 050d056 into main Sep 4, 2025
19 checks passed
@theletterf theletterf deleted the update-applies-to-docs branch September 4, 2025 06:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@florent-leborgne florent-leborgne florent-leborgne left review comments

@colleenmcginnis colleenmcginnis colleenmcginnis approved these changes

@shainaraskas shainaraskas Awaiting requested review from shainaraskas

Assignees

@theletterf theletterf

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Improve inline applies_to documentation

5 participants

@theletterf @florent-leborgne @colleenmcginnis @shainaraskas