Skip to content

Remove applies to glitch from ToC when using inline applies to in headings #1661

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

theletterf
Copy link
Contributor

Fixes #1574

Copy link

github-actions bot commented Jul 30, 2025

🔍 Preview links for changed docs

@theletterf
Copy link
Contributor Author

Copy link
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

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

Thanks @theletterf!

Before we merge this, I'd like to make sure we actually want to allow contributors to use both inline and section annotations with headings. Do we want to enforce one or the other and/or style them the same way for consistency? cc @florent-leborgne @shainaraskas @szabosteve

@theletterf
Copy link
Contributor Author

theletterf commented Jul 30, 2025

Yup, makes sense! IMHO, they don't look great on headings. And, aesthetics aside, I guess it makes more sense to tag meaningful chunks, like a paragraph or a table cell.

@shainaraskas
Copy link
Contributor

I think we don't want to do this and instead want to lint for it so people don't do it

we might want the tags to float inline beside the title, but I think we still want to use the other tagging style because it's easier to scan in markdown. there's a reason why we have these multiple syntax approaches

that being said, might be good to fix the visual bug just in case this sneaks in 🤷

@szabosteve
Copy link

Thank you for the fix and the ping!
We should encourage using the section-style variant if we want to add a tag to a whole section instead of the inline version for the sake of consistency and the reasons Shaina has already mentioned. Still great to have it fixed though!

@theletterf
Copy link
Contributor Author

@elastic/docs-engineering I'm OK with either having this merged or closed!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Request]: Inline applies_to annotations in headings
4 participants