Since the team is apparently reading this, I ran into SVG docs being less than great (to me). I was trying to use SVG and I think the way the docs are presented for SVG elements could maybe use some TLC. For example the 'g' element
What attributes can be used? All it says is "This element only includes global attributes.". Yea, ok, why isn't that a link to what are the global attributes are? There's nothing on the page that gets you to the attributes. Ideally they'd just be on this page so the user doesn't have to go digging.
Clicking "attributes" on the left brings up a list of attributes. Which ones are "global attributes". Why is it organized like this? If it was docs of structures for an API I would not expect each property to have its own page and not be described in that struct's page directly.
struct Person {
name: // links to /docs/name
age: // lines to /docs/age
}
struct Country {
name: // links to /docs/name
population: // links to /docs/population
}
struct Vehicle {
name: // links to docs/name
price: // links to docs/price
}
You'd expect (well, I'd expect), that docs for properties are include in the page.
But that's how the SVG element docs are organized.
Which at least has that element's unique properties listed. Even their though I have to go digging through the hierarchy to find what other properties. It would be way more useful to, at a glance, at least list all the attributes and methods including inherited ones, even if they are just links.
Hi, thank you so much for the kind words and thoughtful feedback, I really appreciate it! I’ll be sure to bring this to the team so we can explore how to improve things further.
We actively monitor feedback on GitHub, so if you have more detailed suggestions or broader ideas, feel free to start a conversation on GitHub Discussions → https://github.com/orgs/mdn/discussions
We’d love to hear more from you and identify areas we can improve together.
Since the team is apparently reading this, I ran into SVG docs being less than great (to me). I was trying to use SVG and I think the way the docs are presented for SVG elements could maybe use some TLC. For example the 'g' element
https://developer.mozilla.org/en-US/docs/Web/SVG/Reference/E...
What attributes can be used? All it says is "This element only includes global attributes.". Yea, ok, why isn't that a link to what are the global attributes are? There's nothing on the page that gets you to the attributes. Ideally they'd just be on this page so the user doesn't have to go digging.
Clicking "attributes" on the left brings up a list of attributes. Which ones are "global attributes". Why is it organized like this? If it was docs of structures for an API I would not expect each property to have its own page and not be described in that struct's page directly.
You'd expect (well, I'd expect), that docs for properties are include in the page.But that's how the SVG element docs are organized.
Compare to HTMLCanvasElement
https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasE...
Which at least has that element's unique properties listed. Even their though I have to go digging through the hierarchy to find what other properties. It would be way more useful to, at a glance, at least list all the attributes and methods including inherited ones, even if they are just links.
Much of this seems semi automatable from IDL?