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

Write a single sidebar for SVG #7171

Closed
3 tasks done
wbamberg opened this issue Sep 16, 2022 · 0 comments · Fixed by #8289
Closed
3 tasks done

Write a single sidebar for SVG #7171

wbamberg opened this issue Sep 16, 2022 · 0 comments · Fixed by #8289
Labels
accepting PR We invite you to open a PR to resolve this issue. idle macros tracking issues related to kumascript macros p3 We don't have visibility when this will be addressed. sidebar/toc Sidebar and table of contents

Comments

@wbamberg
Copy link
Collaborator

wbamberg commented Sep 16, 2022

Summary

The SVG docs should have a single sidebar which helps users discover all pages, not just SVG elements.

Currently it seems that our SVG docs are roughly in three parts:

  • some tutorials
  • lots of SVG element reference pages
  • lots of SVG attribute reference pages

Most of the docs have a sidebar, built using the SVGRef macro: https://github.com/mdn/yari/blob/main/kumascript/macros/SVGRef.ejs. But this macro only lists SVG elements.

The tutorial docs don't have any sidebar at all :(

The macro should be updated to list SVG tutorials and attributes as well, so this other content is more easily discoverable.

URL

https://developer.mozilla.org/en-US/docs/Web/SVG and everything underneath it.

Reproduction steps

  1. visit https://developer.mozilla.org/en-US/docs/Web/SVG
  2. look at the sidebar and see it only shows SVG elements

Expected behavior

A sidebar that helps readers navigate to all parts of the SVG documentation.

Actual behavior

A sidebar that does not help readers navigate to all parts of the SVG documentation.

Device

Laptop

Browser

Firefox

Browser version

Pre-release (e.g. Beta, Nightly or Canary)

Operating system

Mac OS

Screenshot

Screen Shot 2022-09-15 at 10 09 32 PM

Anything else?

No response

Validations

@github-actions github-actions bot added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Sep 16, 2022
@caugner caugner added macros tracking issues related to kumascript macros sidebar/toc Sidebar and table of contents accepting PR We invite you to open a PR to resolve this issue. and removed needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. labels Oct 27, 2022
@caugner caugner added the p3 We don't have visibility when this will be addressed. label Nov 14, 2022
@github-actions github-actions bot added the idle label Dec 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepting PR We invite you to open a PR to resolve this issue. idle macros tracking issues related to kumascript macros p3 We don't have visibility when this will be addressed. sidebar/toc Sidebar and table of contents
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants