-
Notifications
You must be signed in to change notification settings - Fork 22.9k
"Try it" section should not have unrelated content (1) #41944
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
Conversation
Preview URLs (65 pages)
Flaws (2054)URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL:
URL: [`/en-US/docs/Web/CSS/Reference/Properties/border… TRUNCATED! (comment last updated: 2025-11-16 22:07:06) |
chrisdavidmills
left a comment
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.
@Josh-Cena I can see the point of this, but I really think that, where there is a significant amount of text to move, this should be put in a Description section for now. We can always work together to refine those sections as a follow-up task.
Putting too much right below the intro, I feel, spoils the rhythm of that page, makes the time-to-example too long for the reader, and worsens the experience.
files/en-us/web/css/reference/properties/background-clip/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/css/reference/properties/background-image/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/css/reference/properties/border-bottom-left-radius/index.md
Outdated
Show resolved
Hide resolved
chrisdavidmills
left a comment
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.
@Josh-Cena this is much better, thanks.
Many of these new "Description" sections work well as-is, but we should review them to see what edits are needed, as a follow-up project. I'm happy to do some of the leg work here.
There was a time when people were slapping EmbedInteractiveExample randomly in docs, which injects an H2 "Try it" heading that sits very weirdly in between description. Instead, the "Try it" section should exclusively contain the example and nothing else; description about the property should go elsewhere.
I'm not interested in finding the best place to put the text or to rewrite/delete it. I'm simply moving all the text before the InteractiveExample macro.