ipfs-docs icon indicating copy to clipboard operation
ipfs-docs copied to clipboard

Add prev/next links in docs site footer, solving for offsite links

Open ericronne opened this issue 6 years ago • 4 comments

Currently much of the docs content isn't very well threaded, but upcoming changes (like those proposed by @johnnymatthews in ipfs/ipfs-docs#265) should serve to improve the overall content flow from page to page. In the mean time, users may find it handy to have this secondary/analog method of navigation available. This may be especially true for mobile, where users otherwise have to toggle open a menu in order to browse.

HOWEVER, in order to implement this, we must first control for the fact that many left-hand nav links go to external sites. Possible options include:

  • Wait to implement this until we (as planned) migrate a lot of go-ipfs and js-ipfs content out of their respective repos and onto the docs site
  • Make a docs page for each of these links. That page would include brief info gleaned from the destination content, and of course, the link itself.

Mockups

Desktop image

Mobile prev-next-mobile

Svg arrow files Default Hover (if we swap art rather than recoloring on hover)

Default arrow color #Default: #9ad4db Hover arrow color #377f85

ericronne avatar Dec 04 '19 22:12 ericronne

I take it those links need to be defined in the front-matter of each article, correct? Or will it just take those values from the sidebar nav?

johnnymatthews avatar Dec 04 '19 23:12 johnnymatthews

Pretty sure it just auto-populates from the sidebar nav setup.

jessicaschilling avatar Dec 04 '19 23:12 jessicaschilling

It’s auto by default with the option to override or disable per page using some front matter config. Nice and flexible!

On Wed, 4 Dec 2019 at 23:30, Jessica Schilling [email protected] wrote:

Pretty sure it just auto-populates from the sidebar nav setup.

— You are receiving this because you were assigned.

Reply to this email directly, view it on GitHub https://github.com/ipfs/docs/issues/403?email_source=notifications&email_token=AAA2DOTHXUYJFENLTEO5TC3QXA4RPA5CNFSM4JVPYHMKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEF64HLA#issuecomment-561890220, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAA2DOTZ46MTVFZWHRKI363QXA4RPANCNFSM4JVPYHMA .

cwaring avatar Dec 04 '19 23:12 cwaring

This would still be quite cool to have if we could specify the before and next destinations in the front matter. Having it automatically generated from the sidebar nav is likely to cause a bunch of issues.

johnnymatthews avatar Jun 17 '20 20:06 johnnymatthews