Skip to content

docs: use emoji markers in target summary matrix - #2701

Open
Bruno Borges (brunoborges) wants to merge 1 commit into
microsoft:mainfrom
brunoborges:brunoborges-emoji-summary-matrix
Open

docs: use emoji markers in target summary matrix#2701
Bruno Borges (brunoborges) wants to merge 1 commit into
microsoft:mainfrom
brunoborges:brunoborges-emoji-summary-matrix

Conversation

@brunoborges

Copy link
Copy Markdown
Member

Description

The targets summary matrix used text-like checkbox markers that were slower to distinguish at a glance. This change replaces supported and unsupported markers with ✅ and ❌ while preserving every support state and the IntelliJ footnotes.

Trade-off: This intentionally introduces Unicode into this documentation table to provide the requested visual scanability; no CLI output or source behavior changes.

N/A - no linked issue.

Type of change

  • Bug fix
  • New feature
  • Documentation
  • Maintenance / refactor

Testing

  • Tested locally
  • All existing tests pass
  • Added tests for new functionality (if applicable)

Validation: the full CI lint mirror passed with Ruff, Ruff formatting, pylint duplicate-code detection, and the auth-signal boundary check.

Spec conformance (OpenAPM v0.1)

If this PR changes behaviour that an OpenAPM v0.1 req-XXX covers,
confirm the three-step ritual (see CONTRIBUTING.md "Adding or
changing a normative requirement"):

  • Spec edit: docs/src/content/docs/specs/openapm-v0.1.md updated
    (new/changed <a id="req-XXX"></a> anchor + prose + Appendix C
    row).
  • Manifest edit: docs/src/content/docs/specs/manifests/openapm-v0.1.requirements.yml
    updated.
  • Test edit: a @pytest.mark.req("req-XXX") test under
    tests/spec_conformance/ added or extended.
  • CONFORMANCE.{md,json} regenerated via
    uv run --extra dev python -m tests.spec_conformance.gen_statement
    and committed.
  • N/A -- this PR does not change OpenAPM-observable behaviour.

Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates the documentation "targets summary matrix" to use more visually distinct markers for supported vs unsupported capabilities across APM targets.

Changes:

  • Replaces [x] / [ ] table markers with Unicode checkmark / cross symbols while keeping the same support states.
  • Preserves the existing IntelliJ footnote markers ((*)) in the table.
Show a summary per file
File Description
docs/src/content/docs/reference/targets-matrix.md Swaps the support/unsupported indicators in the summary matrix to improve scanability while keeping the same target capability mapping.

Review details

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

  • Files reviewed: 1/1 changed files
  • Comments generated: 0
  • Review effort level: Lite

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants