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

Sidebar reorganisation proposal #6845

Open
delucis opened this issue Feb 9, 2024 · 9 comments · May be fixed by #8197
Open

Sidebar reorganisation proposal #6845

delucis opened this issue Feb 9, 2024 · 9 comments · May be fixed by #8197
Labels
site improvement Some thing that improves the website functionality - ask @delucis for help!

Comments

@delucis
Copy link
Member

delucis commented Feb 9, 2024

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
@sarah11918
Copy link
Member

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
Copy link
Member

Still happy with this proposal!

@SatanshuMishra
Copy link
Contributor

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

@linear linear bot changed the title Sidebar reorganisation proposal Reorganise docs right sidebar content Apr 1, 2024
@linear linear bot changed the title Reorganise docs right sidebar content Sidebar reorganisation proposal Apr 12, 2024
@sarah11918
Copy link
Member

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

@sarah11918 sarah11918 added the site improvement Some thing that improves the website functionality - ask @delucis for help! label May 4, 2024
@delucis
Copy link
Member Author

delucis commented May 4, 2024

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

@SatanshuMishra
Copy link
Contributor

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

@sarah11918
Copy link
Member

Bring it, @SatanshuMishra ! 😄

@SatanshuMishra
Copy link
Contributor

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.

@delucis
Copy link
Member Author

delucis commented May 6, 2024

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!

@SatanshuMishra SatanshuMishra linked a pull request May 7, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
site improvement Some thing that improves the website functionality - ask @delucis for help!
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants