Persisting store doc href hash fixes and tweaks

[wmcb91]

Related Issues

Issue not created, but the problem can be replicated by visiting https://docs.pmnd.rs/zustand/integrations/persisting-store-data, then clicking on the "Hydration and asynchronous storages" link in the second paragraph.

Summary

Main fix

Make section hash hrefs all lowercase so in-page links work properly on Persisting Store page. The problem likely stemmed from porting Github's implementation of markdown, which is capitalization agnostic about URL hashes, to the new docs framework.

Secondary enhancements

• Remove a "see below for more details" link that is linked to the next section.
• Add additional context to a different "see below" statement.

Check List

• yarn run prettier for formatting code and docs

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit c2474a6:

Sandbox	Source
React	Configuration
React Typescript	Configuration
React Browserify	Configuration
React Snowpack	Configuration
React Parcel	Configuration
Next.js	Configuration

[chrisk-7777]

The inclusion of the "?" is an interesting one. For a quick bit of background, we want the docs to work on the docs site, but also, we want them to continue to work within Github.

At the moment, the fix here makes sense in the context of the docs (which is currently broken for that link), but it wouldn't work in the context of Github, because it looks like Github strips the "?".

I wonder if we can introduce a fix on https://github.com/pmndrs/website/ so it is consistent with github? Technically a question mark is allowed in the fragment identifier but it would be good to be consistent across both GH/docs.

Sorry, I know that is a bit of a rabbit hole for a case fix! Is it something you want to raise/fix with the website repo? If not, I can look at doing it

[chrisk-7777]

A quick update @wmcb91 , I've raised a query over on the website repo: https://github.com/pmndrs/website/issues/259
I want to get Cody's 2c on the approach. Sorry about the hold up

[chrisk-7777]

Thanks! Good eye on the case in those links. I just had a quick comment about the "?"

[wmcb91]

Hi @chrisk-7777, that was my fault for not checking if the behavior still worked in Github. It's probably worthwhile continuing to explore how to make the website hashes and Github hashes compatible.

If we want to allow that work to be done asynchronously while making this PR mergeable, a solution could be to remove the link and leave the text since the section is directly below and it would be difficult to miss. It could be bold, italic or both to indicate a title section.

[chrisk-7777]

Hi @chrisk-7777, that was my fault for not checking if the behavior still worked in Github. It's probably worthwhile continuing to explore how to make the website hashes and Github hashes compatible.

If we want to allow that work to be done asynchronously while making this PR mergeable, a solution could be to remove the link and leave the text since the section is directly below and it would be difficult to miss. It could be bold, italic or both to indicate a title section.

Hey @wmcb91 I think this is a great way forward while the site is updated in parallel 👍