Standardize hardware documentation

[tekstrand]

What

1. Update headings to follow semantic guidelines
2. Shorten some tab names (t-beam)
3. Add missing headings under tabs for semantics
4. Remove extra duplicate words from headings when parent heading already contains context
5. Standardize purchase link formatting for all RAK devices

Why

1. Semantic html is easier to read, better for accessibility, and better for SEO
2. There were enough tab names and the names were long enough that they were starting to wrap

Screenshots

[vercel]

@tekstrand is attempting to deploy a commit to the Meshtastic Team on Vercel.

A member of the Team first needs to authorize it.

[CLAassistant]

All committers have signed the CLA.

[pdxlocations]

@tekstrand These edits look great! Would you mind signing the CLA?

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
meshtastic	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 26, 2024 7:18pm

[rcarteraz]

4. Remove extra duplicate words from headings when parent heading already contains context

The reason for this is because otherwise the headings in the navigation sidebar are all the same. It hasn’t been done universally, even though I planned to.

This differentiates them. Examples with and without.
(sorry for mobile but it’s the same on desktop just on the right instead).

[tekstrand]

Ah that is a real bummer. A result of using tabs unfortunately. Definitely do not merge this as is - we need to either add them back and standardize that or create a fix for the tabs.

[rcarteraz]

Ah that is a real bummer. A result of using tabs unfortunately. Definitely do not merge this as is - we need to either add them back and standardize that or create a fix for the tabs.

Yes, the tabs unfortunately cause a couple issues like this but that’s the option we have right now unless we add a page for every device and that’s too much imo.

However, we are currently exploring alternatives to Docusarus for reasons like this. See: https://discord.com/channels/867578229534359593/871540428510474302/1193046126031544472

there’s a thread with the discussion.

[tekstrand]

@rcarteraz thoughts on this solution? https://docusaurus.io/docs/api/themes/configuration#table-of-contents

[rcarteraz]

@rcarteraz thoughts on this solution? https://docusaurus.io/docs/api/themes/configuration#table-of-contents

Amazing!… And now I feel pretty stupid for missing that. Thank you!

[tekstrand]

Realized that the default config worked so reverted back, however did convert the indentation in that file over to spaces. If I need to remove that commit just lmk.

[pdxlocations]

I love the new look of the TOC! The links never actually worked unless you're in the tab already so that's still a bummer.

[tekstrand]

♻️ updated with feedback

Tabs/TOC is an interesting topic. There's an issue that was closed by the maintainer of docusaurus requesting the feature. Amazed at the attitude that guy is responding with but that is beside the point.

I know we are considering a move to a different docs platform. I am not sure how many users we have that are visually impaired or using screen reading devices, but we should be sure consider those users as we choose a new platform and make UX decisions around doc structure.

[rcarteraz]

♻️ updated with feedback

Tabs/TOC is an interesting topic. There's an issue that was closed by the maintainer of docusaurus requesting the feature. Amazed at the attitude that guy is responding with but that is beside the point.

I know we are considering a move to a different docs platform. I am not sure how many users we have that are visually impaired or using screen reading devices, but we should be sure consider those users as we choose a new platform and make UX decisions around doc structure.

Yeah, slorber. Quite the douchebag if I’m being honest.

[pdxlocations]

I know we are considering a move to a different docs platform. I am not sure how many users we have that are visually impaired or using screen reading devices, but we should be sure consider those users as we choose a new platform and make UX decisions around doc structure.

I second this.

[tekstrand]

♻️ purchase links standardized across all RAK pages. Will follow up with PRs for other devices but starting with RAK here.

[tekstrand]

We'll call you hawkeye from now on! 😂

[pdxlocations]

I think this is ready to ship, unless @rcarteraz has any suggestions?

[tekstrand]

Sounds good, I'll start working on the other sections once this is merged.