Skip to content

Add quick reference to applies_to syntax page#3475

Merged
theletterf merged 2 commits into
mainfrom
docs/applies-to-tldr
Jun 5, 2026
Merged

Add quick reference to applies_to syntax page#3475
theletterf merged 2 commits into
mainfrom
docs/applies-to-tldr

Conversation

@leemthompo
Copy link
Copy Markdown
Member

@leemthompo leemthompo commented Jun 5, 2026

Summary

  • Simplifies the intro paragraph to explain cumulative docs in plain terms
  • Adds a quick-reference table at the top so docs contributors can match their situation to the right annotation type
  • Links to the applies-to-tagging skill

Background

I still need to point humans to a TLDR for applies_to and recommend the skill, so it makes sense to simplify the intro to the syntax reference and add a scannable entry point. The existing page is comprehensive but front-loads complexity. This adds a quick reference without changing any of the detailed reference material.

🤖 Generated with Claude Code

Simplify the intro, add a quick-reference table so docs contributors
can match their situation to the right annotation type, and link to
the applies-to-tagging skill.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@leemthompo leemthompo self-assigned this Jun 5, 2026
@leemthompo leemthompo added the documentation Improvements or additions to documentation label Jun 5, 2026
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@leemthompo leemthompo temporarily deployed to integration-tests June 5, 2026 11:53 — with GitHub Actions Inactive
@leemthompo leemthompo marked this pull request as ready for review June 5, 2026 11:54
@leemthompo leemthompo requested review from a team as code owners June 5, 2026 11:54
@leemthompo leemthompo requested a review from cotti June 5, 2026 11:54
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 5, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 5dadb455-22aa-440f-adc4-6e7a51a8d025

📥 Commits

Reviewing files that changed from the base of the PR and between d115285 and 242c9ca.

📒 Files selected for processing (1)
  • docs/syntax/applies.md

📝 Walkthrough

Walkthrough

This PR updates the applies.md syntax documentation to replace version-specific guidance with a cumulative-model description of Elastic's documentation approach. The changes remove the "starting with Elastic Stack 9.0" framing, add a Claude Code tip for generating and validating applies_to tags, and introduce a new quick-reference section with guiding questions and a table that maps common documentation scenarios to the appropriate applies_to metadata placement methods.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding a quick reference section to the applies_to syntax documentation page.
Description check ✅ Passed The description is directly related to the changeset, explaining the motivation, what was added (quick-reference table, simplified intro), and what was not changed.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/applies-to-tldr

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@theletterf theletterf enabled auto-merge (squash) June 5, 2026 12:01
@theletterf theletterf merged commit b86c5ee into main Jun 5, 2026
25 checks passed
@theletterf theletterf deleted the docs/applies-to-tldr branch June 5, 2026 12:05
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.

2 participants