-
Notifications
You must be signed in to change notification settings - Fork 23
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
base: main
Are you sure you want to change the base?
Conversation
🔍 Preview links for changed docs |
@colleenmcginnis You can check the fix here: https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/1661/syntax/applies#in-text (ToC is pristine) |
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 @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
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. |
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 🤷 |
Thank you for the fix and the ping! |
@elastic/docs-engineering I'm OK with either having this merged or closed! |
Fixes #1574