docs(conditions): link GitHub-sourced attributes to their GitHub documentation#12022
Merged
Conversation
Contributor
Merge Protections🟢 All 7 merge protections satisfied — ready to merge. Show 7 satisfied protections🟢 ⛓️ Depends-On RequirementsRequirement based on the presence of
🟢 🤖 Continuous Integration
🟢 👀 Review Requirements
🟢 Enforce conventional commitMake sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
🟢 🔎 Reviews
🟢 📕 PR description
🟢 🚦 Auto-queueWhen all merge protections are satisfied, this pull request will be queued automatically. |
There was a problem hiding this comment.
Pull request overview
Adds support for linking GitHub-sourced pull request attributes to their upstream GitHub documentation, using a documentation_url field carried in the schema’s x-mergify-attribute-metadata extension. This improves the attribute reference table in both the docs UI and the markdown/LLM export, while intentionally skipping the search-highlight rendering path to avoid URL corruption.
Changes:
- Added
getAttributeDocumentationUrl()helper to readdocumentation_urlfrom attribute metadata, plus unit tests. - Updated the markdown export to append a “GitHub documentation” link for attributes that carry a documentation URL.
- Updated the HTML attributes table to render a “GitHub documentation” link below the description (omitted for
staticAttributes/ search-highlight rendering), with styling.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/util/schemaToMarkdown.ts | Appends a documentation link into the markdown-exported attributes table. |
| src/util/attributeMetadata.ts | Refactors metadata access and adds getAttributeDocumentationUrl(). |
| src/util/attributeMetadata.test.ts | Adds unit tests for the new metadata accessor. |
| src/components/Tables/PullRequestAttributes.tsx | Renders an optional “GitHub documentation” link under the description in the UI table (skipped for search-highlight path). |
| src/components/Tables/PullRequestAttributes.module.css | Adds styling for the new documentation link block. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…mentation Render a "GitHub documentation" link from the documentation_url published in the schema's x-mergify-attribute-metadata extension: under the attribute description in the HTML attributes table, and appended inline to the description cell in the markdown/LLM export. The link is omitted in the search-highlight render path, whose highlight markers would corrupt the URL. Until the engine schema carrying documentation_url is synced, the tables render unchanged. Depends-On: Mergifyio/monorepo#36225 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012ZfAq32gVtFih34eYFeEAr Change-Id: If95fda51d6ef50cad9a46947c59558fe96a895e3
JulianMaurin
force-pushed
the
devs/JulianMaurin/github-sourced-attributes/link-github-sourced-attributes-their-github-docs--f95fda51
branch
from
63b3337 to
a753e69
Compare
Contributor
Author
Revision history
|
jd
approved these changes
Jul 3, 2026
kozlek
approved these changes
Jul 6, 2026
Contributor
Merge Queue Status
This pull request spent 3 minutes 43 seconds in the queue, including 2 minutes 46 seconds running CI. Required conditions to merge
|
55 tasks
mergify
Bot
deleted the
devs/JulianMaurin/github-sourced-attributes/link-github-sourced-attributes-their-github-docs--f95fda51
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Render a "GitHub documentation" link from the documentation_url published in
the schema's x-mergify-attribute-metadata extension: under the attribute
description in the HTML attributes table, and appended inline to the
description cell in the markdown/LLM export. The link is omitted in the
search-highlight render path, whose highlight markers would corrupt the URL.
Until the engine schema carrying documentation_url is synced, the tables
render unchanged.
Depends-On: Mergifyio/monorepo#36225
Co-Authored-By: Claude Fable 5 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_012ZfAq32gVtFih34eYFeEAr