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

DOC-3967 Restructure sidebar #429

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

andy-stark-redis
Copy link
Contributor

@andy-stark-redis andy-stark-redis commented Jul 11, 2024

There are a few places where I've changed some of the content but it would be great if you could just have a play with the sidebar in the staging page and let me know if there is anything major missing or listed in the wrong order. Also, any further suggestions for styling are still welcome :-) BTW, only the Develop With Redis section has the sidebar for now. I'll also add some instructions elsewhere to explain how to add new pages to the index.

@andy-stark-redis andy-stark-redis requested review from mortensi and a team July 11, 2024 13:33
@andy-stark-redis andy-stark-redis self-assigned this Jul 11, 2024
@andy-stark-redis
Copy link
Contributor Author

I've noticed a few glitches in the staged build of the docs, so I've added "do not merge" for now. I'll get them fixed ASAP.

@mich-elle-luna
Copy link
Collaborator

mich-elle-luna commented Jul 11, 2024

I'm not sure if it is possible to collapse the top level headings? I feel there are too many items open that it is overwhelming. If we could have the top-level collapsed and appear as normal text (no divider block of grey) it may feel less overwhelming and still enable readers to look at multiple categories. I'm not sure if it can actually work this way with Hugo, but this is what I'm thinking from left to right when you click where the arrow appears, the image to the right shows how it would appear:
image

@andy-stark-redis
Copy link
Contributor Author

@mich-elle-luna I think that having more top-level items open and clearly visible was a major part of this task (eg, you shouldn't have to dig down to see something as important as Search and Query). But yeah, I do agree that having too many top-level items isn't good either. I've collapsed the Reference section at the bottom, since it doesn't really need to be open. Also, it is part of the plan to remove the Use Redis section altogether, because those pages can easily be re-homed in better places (eg, Keyspace notifications should probably go in a folder with Pub/sub). I wanted to get some feedback about the general feel of the sidebar before removing Use Redis because this step will involve a bit of rewriting here and there. But if you think it's best to remove it before launching the new sidebar then I'm fine with that.

@dwdougherty dwdougherty added the ui label Jul 12, 2024
@mich-elle-luna
Copy link
Collaborator

Hi @andy-stark-redis thanks, collapsing reference definitely helps! For the styling, maybe we could replace the grey bar and just have these sections look like the other open sections with the left-side vertical grey line?

@CLAassistant
Copy link

CLAassistant commented Oct 8, 2024

CLA assistant check
All committers have signed the CLA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants