Skip to content
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

feat(macros): Rewrite MathML sidebar #8309

Merged
merged 2 commits into from
Mar 4, 2023
Merged

Conversation

wbamberg
Copy link
Collaborator

Summary

This PR rewrites the current MathML sidebar, MathMLRef.ejs.

Problem

The immediate reason for this is that the current sidebar uses tags, and we want to stop using tags.

But the current sidebar is also not very useful: it only lists elements, not attributes or any guide/tutorial content.

Solution

This sidebar is pretty much cloned from the PR to rewrite the SVG sidebar, but the content is a little different:

  • Guides
  • Reference
    • Elements
    • Global attributes
    • Attributes reference
  • Examples

Some notes and things.

  • There's definitely scope to have a similar organization and ordering at the top level for many of our sidebars (i.e Tutorials/Guides/Reference or something) maybe based explicitly on Divio. There are definitely some pointless inconsistencies at the moment. But that's another story.
  • There's also scope for making this sidebar data-driven as we are prototyping in feat(macros): rewrite Learn sidebar #8132. But again, another story.
  • This sidebar gets labels from page titles, and some page titles could perhaps be adjusted, like MathML: Deriving the Quadratic Formula -> "Deriving the Quadratic Formula". We will need a follow-up anyway in content to call this sidebar everywhere, so maybe I'll do that then.

Screenshots

Before

Screen Shot 2023-02-24 at 4 52 21 PM

After

collapsed:

Screen Shot 2023-02-24 at 4 55 24 PM

expanded:

Screen Shot 2023-02-24 at 4 55 48 PM

Testing

Testing: fire up yarn dev and visit:

@teoli2003 , @hamishwillee , @fred-wang

@github-actions github-actions bot added the macros tracking issues related to kumascript macros label Feb 25, 2023
@wbamberg wbamberg changed the title Rewrite MathML sidebar feat(macros): Rewrite MathML sidebar Feb 25, 2023
Copy link
Contributor

@teoli2003 teoli2003 left a comment

Choose a reason for hiding this comment

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

👍

Copy link
Contributor

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

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

Again, much better than what was there.

@caugner caugner added the sidebar/toc Sidebar and table of contents label Mar 2, 2023
@caugner caugner merged commit f92eb77 into mdn:main Mar 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
macros tracking issues related to kumascript macros sidebar/toc Sidebar and table of contents
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants