-
Notifications
You must be signed in to change notification settings - Fork 22.5k
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
Fix API overview sidebars #22468
Fix API overview sidebars #22468
Conversation
Preview URLs (6 pages)Flaws (6)Note! 5 documents with no flaws that don't need to be listed. 🎉 URL:
|
I started mdn/mdn-community#291 for Constraint Validation. |
Aside from the Push API page, the preview pages look better. I had to look up the macro to find out what it does, but I could still do with hints when to use this over other. Do we need to add anything to the sidebar docs for this? The Prettier formatting looks good. |
API overview pages (that is, pages with A long time ago I wrote up a kind of guide to them: https://discourse.mozilla.org/t/defaultapisidebar-apiref-and-groupdata/40210 but I don't know if there is anything comparable on MDN.
Those docs are hopelessly inadequate, so probably. Sidebars for Web/API are ridiculously complicated. Ruth and I proposed a much simpler solution in openwebdocs/project#76 but it doesn't seem to be going anywhere at the moment. (I suppose, rather than write more meta-docs, I'd like to put time into simplifying our sidebar system. Which sidebar to use for what page shouldn't even be an authorial choice.) |
Thank you for the explanation! |
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.
Looks good, thank you! I'm happy to merge when you are.
This PR fixes all the "web-api-overview" pages under Web/API which erroneously use "APIRef" instead of "DefaultAPISidebar".
Except for https://developer.mozilla.org/en-US/docs/Web/API/Constraint_validation.