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.

Sign up for GitHub

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

Jump to bottom

feat(www) Table of contents for API reference pages #21808

Closed
tesseralis opened this issue Feb 28, 2020 · 4 comments · Fixed by #23537
Closed

feat(www) Table of contents for API reference pages #21808

tesseralis opened this issue Feb 28, 2020 · 4 comments · Fixed by #23537
Labels
help wanted Issue with a clear description that the community can help with.

Comments

@tesseralis
Copy link
Contributor

Summary

API reference pages, such as node-apis do not use our standard table of contents, instead using an inline component:

API table of contents

This is suboptimal, since it's stuck on the page content and we don't get the nice table of contents sidebar like we do in normal docs.

Implementation

We'd need to change the table of contents component to take in a generic list of items rather than a page objects. Once this is done, it should be fairly straightforward to add it to the api template.

Related Issues

We may want to wait until #21762 to go in, since that also changes the table of contents component a fair bit.
@tesseralis tesseralis added type: feature or enhancement help wanted Issue with a clear description that the community can help with. labels Feb 28, 2020
@tesseralis tesseralis mentioned this issue Feb 28, 2020
Merged
@github-actions
Copy link

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 30 days of inactivity. It’s been at least 20 days since the last update here.
If we missed this issue or if you want to keep it open, please reply here. You can also add the label "not stale" to keep this issue open!
As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks for being a part of the Gatsby community! 💪💜

@github-actions github-actions bot added the stale? Issue that may be closed soon due to the original author not responding any more. label Mar 19, 2020
@github-actions
Copy link

Hey again!

It’s been 30 days since anything happened on this issue, so our friendly neighborhood robot (that’s me!) is going to close it.
Please keep in mind that I’m only a robot, so if I’ve closed this issue in error, I’m HUMAN_EMOTION_SORRY. Please feel free to reopen this issue or create a new one if you need anything else.
As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks again for being part of the Gatsby community! 💪💜

@wardpeet wardpeet reopened this Mar 31, 2020
@wardpeet wardpeet added not stale and removed stale? Issue that may be closed soon due to the original author not responding any more. labels Mar 31, 2020
@andresz1
Copy link
Contributor

andresz1 commented Apr 27, 2020 •
edited
Loading

Hi! I'd like to contribute taking this one 😄can I ?

@andresz1 andresz1 mentioned this issue Apr 27, 2020
Merged
@andresz1
Copy link
Contributor

andresz1 commented Apr 27, 2020 •
edited
Loading

Just opened a PR @wardpeet Let me know if I should change something please 🙏 is my first one!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted Issue with a clear description that the community can help with.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Table of contents for API reference pages andresz1/gatsby
5 participants
@danabrit @wardpeet @tesseralis @andresz1 @LekoArts