Skip to content

fix(docs): Render inline code in convention descriptions - #652

Open
sentry-junior[bot] wants to merge 2 commits into
mainfrom
fix/attribute-inline-markdown
Open

sentry-junior[bot] wants to merge 2 commits into
mainfrom
fix/attribute-inline-markdown

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Attribute cards interpolate model prose as plain text, so backticks in descriptions such as gen_ai.input.messages appear literally instead of producing inline code. The existing operations helper only recognizes links.

Use a shared, restricted Markdown parser for attribute prose and operation descriptions. Enable inline code and HTTP(S) links while keeping raw HTML and images disabled, and leave examples and raw JSON untouched. Add regression coverage for the reported description, backtick delimiters, link handling, and HTML escaping.

Local rendering after the fix — gen_ai.input.messages:

Attribute description rendering backtick-delimited values as inline code

via Andrei Borza.

--

View Junior Session [Sentry]

Co-Authored-By: Andrei Borza <andrei.borza@sentry.io>
@vercel

vercel Bot commented Sep 25, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
sentry-conventions Ready Ready Preview Sep 25, 2026 2:31pm UTC

Request Review

@github-actions

Copy link
Copy Markdown

Semver Impact of This PR

🟢 Patch (bug fixes)

📋 Changelog Preview

This is how your changes will appear in the changelog.
Entries from this PR are highlighted with a left border (blockquote style).


New Features ✨

  • (docs) Add Vercel PR previews by sentry-junior in #651

Bug Fixes 🐛

  • (docs) Render inline code in convention descriptions by sentry-junior[bot] in #652

Documentation 📚

  • Specify TTL lifetime by s1gr1d in #648

🤖 This preview updates automatically when you update the PR.

Co-Authored-By: Andrei Borza <andrei.borza@sentry.io>

This branch was successfully deployed

1 active deployment
Preview — afa8020f Deployed Sep 25, 2026 by vercel[bot]
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.

0 participants