-
Notifications
You must be signed in to change notification settings - Fork 188
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.
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
[chore] Add anchors to individual attributes in a markdown table #1041 #1480
Conversation
Co-authored-by: Joao Grassi <[email protected]>
…enerating `id` and `href` attributes.
…enerating `id` and `href` attributes.
Ah.. I forgot that the link check may not work/like the anchor links in the URL 😞. Hum not sure if there's a way around it. I will try to check. |
Ooh, alright |
I pushed a workaround that skips local anchor links for now. Let's see if it passes. |
Hey @joaopgrassi I guess the test passed? Thanks for the workaround. What next now? |
Needs more approvals, so we need to wait for others to review it as well. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks! lgtm
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for doing this!
It would also be great to update the markdown tables that already reference registry attributes.
E.g. here
semantic-conventions/docs/http/http-spans.md
Line 145 in e038c11
| [`http.request.method`](/docs/attributes-registry/http.md) | string | HTTP request method. [1] | `GET`; `POST`; `HEAD` | `Required` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | |
@lmolkova Sure, but I suggest that can be addressed in a different PR as a different issue after this is merged, for clarity sake. Your thoughts? |
@RichardChukwu sure! |
Fixes #1041
Changes
Added anchor tags to individual attributes in the markdown table.
Each attribute now has a corresponding element, allowing direct linking to the specific attribute from the table of contents or other parts of the documentation.
The anchor is dynamically generated using the attribute’s name, converted to a URL-friendly format (lowercase, spaces replaced with hyphens).
This ensures that each attribute can be easily referenced by creating links to the anchor IDs.
Merge requirement checklist
[chore]