search

open-sauced / intro

Empowering Your Open Source Journey: From First Contribution to Project Leadership
https://opensauced.pizza/learn
Other
525 stars 103 forks source link

Page navigation improvements #15

Closed herorelative closed 1 year ago

herorelative commented 1 year ago

Description

This PR adds an auto2top config to reset the scroll position when the user clicks another page link. This PR also adds the docsify pagination to improve UX when reading on mobile devices. This PR removes the next section links from 01, 02, 03, 04, 05, and 06 md files.

What type of PR is this? (check all applicable)

Related Tickets & Documents

Mobile & Desktop Screenshots/Recordings

Added tests?

Added to documentation?

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

netlify[bot] commented 1 year ago

Deploy Preview for sauced-intro ready!

Name Link
Latest commit e83ee3d37f84005ab35c51123ca389c5a58f2380
Latest deploy log https://app.netlify.com/sites/sauced-intro/deploys/64bbd4ca919b320008cef3c5
Deploy Preview https://deploy-preview-15--sauced-intro.netlify.app/
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

bdougie commented 1 year ago

This is unfortunately not an ideal solution, as it breaks routing for the markdown. Instead I'd propose we add redirects for Netlify and native links in the markdown.

In the repo

Swap out links from this:

[Next Section ->](https://github.com/open-sauced/intro/blob/main/04-tools-to-be-successful.md)

to this:

[Next Section ->](/04-tools-to-be-successful)

Netlify redirects

Netlify offers a feature that could redirect the above /04-tools-to-be-successful to /#/04-tools-to-be-successful which is needed.

https://docs.netlify.com/routing/redirects/

If you are unfamiliar with Netlify Redirects they have a helpful community and we have a few Netlify employees in our Discord that are helpful as well.

herorelative commented 1 year ago

Thanks, @bdougie for the suggestion.

Please allow me to try and adjust it accordingly.

What do you think about the auto2top config?