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

Show guide pages in {{APIRef}} macro #6229

Open
wbamberg opened this issue May 11, 2022 · 2 comments
Open

Show guide pages in {{APIRef}} macro #6229

wbamberg opened this issue May 11, 2022 · 2 comments
Labels
accepting PR We invite you to open a PR to resolve this issue. idle macros tracking issues related to kumascript macros p4 Not urgent, only if time allows sidebar/toc Sidebar and table of contents

Comments

@wbamberg
Copy link
Collaborator

Currently we show guide pages in the {{DefaultAPISidebar}} macro, but not in {{APIRef}}, It would be good to list guide pages in {{APIRef}} as well.

See also: mdn/content#13761 and https://discourse.mozilla.org/t/defaultapisidebar-apiref-and-groupdata/40210/12.

@github-actions github-actions bot added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label May 11, 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 Sep 13, 2022
@caugner caugner added the p4 Not urgent, only if time allows label Nov 14, 2022
@github-actions github-actions bot added the idle label Dec 21, 2022
@caugner
Copy link
Contributor

caugner commented Jun 24, 2024

@wbamberg Are you still interested in this? If so, can you provide some concrete examples of pages using the APIRef sidebar and which Guide(s) you would hope to see in the sidebar? 🙏

@github-actions github-actions bot removed the idle label Jun 25, 2024
@wbamberg
Copy link
Collaborator Author

wbamberg commented Jul 1, 2024

Any page with APIRef (interfaces, methods, properties, events) ought to have a "group" in groupdata.json that represents the API it belongs to, and that group may list guides relevant to the API. Those guides should appear in the APIRef sidebar as well as the DefaultAPISidebar.

For example, the page for Request (and all of its subpages) ought to have a link to Using the Fetch API. As it is, people have to know they must click "Fetch API" at the top to get to a place where they can see a link to the guide.

It would be worth considering cases where there are lots of guides, and we occasionally have tutorials (https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API and https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API) so it might be better to collapse the "guides" and "tutorials" sections in APIRef sidebars.

@github-actions github-actions bot added the idle label Aug 1, 2024
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 p4 Not urgent, only if time allows sidebar/toc Sidebar and table of contents
Projects
Status: No status
Development

No branches or pull requests

2 participants