docs icon indicating copy to clipboard operation
docs copied to clipboard

Published 20 hours ago • verified publisher icon withastro

Sidebar reorganisation proposal

Open delucis opened this issue 1 year ago • 9 comments

Prompted by #6791, I wanted to share a plan for the page sidebar to address a few longstanding issues.

Current sidebar

docs sidebar featuring table of contents and a contribute section with links to contribute, edit, translate, and give feedback

Overall aims

  • Stop using the page sidebar for links other than table of contents. Links here are inaccessible on narrower viewports.
  • Create space for new helpful links, notably to https://community.astro.build

Proposal

  1. Move our edit and translate links down to the bottom of the page content. An edit link is displayed there already currently, we’d add the translation one.
  2. Create a new page footer below the pagination arrows for additional links. Initially these would be our current “Contribute” and “Give Feedback” items from the sidebar, plus a new “Community” link.

Overall the result would look something like this:

docs page section showing edit and translate links above the pagination arrows, and a footer below that with contribute, feedback, and community links

delucis avatar Feb 09 '24 18:02 delucis

Just adding my approval here! I love this idea because it always bothered me that some links were not available in certain viewport sizes.

Now that we have https://community.astro.build and hope to use it for more, docs doesn't have to be the place that links to absolutely everything! If we link to just the community site, then people can get what they want in the right spot!

sarah11918 avatar Feb 09 '24 22:02 sarah11918

Still happy with this proposal!

sarah11918 avatar Feb 16 '24 03:02 sarah11918

I would love to collaborate on this and come up with an better solution to the current implementation.

SatanshuMishra avatar Feb 20 '24 03:02 SatanshuMishra

Are we still liking this @delucis ? Is this something that we're happy to have community members attempt?

sarah11918 avatar May 04 '24 22:05 sarah11918

Definitely! Happy to provide any guidance if anyone would like to attempt all or some of this.

delucis avatar May 04 '24 22:05 delucis

Now that I've some more time, would love to take this on @delucis!

SatanshuMishra avatar May 04 '24 22:05 SatanshuMishra

Bring it, @SatanshuMishra ! 😄

sarah11918 avatar May 04 '24 22:05 sarah11918

Quick Clarification @delucis. For the footer below the pagination, should a new component be created? Or do you think adding it to the pagination component is sufficient?

Depending on what we want to add to this, a new component may be the way to go. However, if we want to keep it to simple links, may be too much abstraction for a simple problem.

SatanshuMishra avatar May 06 '24 21:05 SatanshuMishra

should a new component be created? Or do you think adding it to the pagination component is sufficient?

Either is probably fine to start with — we can always move things around. Personally, I'd probably make a dedicated component for the links and then add it to footer.

Thanks @SatanshuMishra!

delucis avatar May 06 '24 23:05 delucis