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

Always show TOC and move it to bottom on mobile #2969

Merged
merged 1 commit into from
Feb 23, 2024

Conversation

Dieken
Copy link
Contributor

@Dieken Dieken commented Feb 14, 2024

Fixed issue #925.

@bishabosha bishabosha self-assigned this Feb 14, 2024
@bishabosha bishabosha self-requested a review February 14, 2024 09:04
@Dieken
Copy link
Contributor Author

Dieken commented Feb 23, 2024

CI failure isn't caused by this PR.

@bishabosha
Copy link
Member

hey, sorry I forgot to look at this

@bishabosha
Copy link
Member

bishabosha commented Feb 23, 2024

I think it's not obvious when reading the page that the TOC even exists because it's after everything, maybe users won't scroll far enough to notice it.

perhaps there should be a banner at the top/bottom that links to the TOC? (or a sticky one that follows you as you read e.g. Getting Started guide)

Screenshot 2024-02-23 at 10 31 28

Copy link
Member

@bishabosha bishabosha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it should be more clear how to find the toc on mobile

@bishabosha
Copy link
Member

bishabosha commented Feb 23, 2024

still it could be a follow-up PR to add the links, thank you!

@bishabosha bishabosha merged commit 60aea65 into scala:main Feb 23, 2024
@Dieken
Copy link
Contributor Author

Dieken commented Feb 23, 2024

I think it should be more clear how to find the toc on mobile

It’s better to convert the whole table of content into a menu button on narrow screen, touching or clicking the menu button will expand or collapse the table of content.

But that change is too difficult for me, this patch put the toc bottom, it’s already much better now:

  • the first page is reached from header menu, so it’s fine to not see the toc immediately, actually the toc is too long, it must’t be placed on the top of content.

  • when finish one chapter, the reader will notice the toc.

  • if the reader doesn’t jump on chapters, he can just follow the prev/next links, same experience as before, because the toc never shows before the content.

So, it’s good enough for me, very usable now:-)

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

Successfully merging this pull request may close these issues.

2 participants