Update guide

[panathea]

Update the assembly guide for clarity.

• Crop photos to highlight relevant part, label parts in overview photo, add encoder guide photo.
• Suggest some additional tools
• Fix some grammar issues, improve phrasing for some awkward sentences.
• Include the depanelization video with the hammer
• Reorder some instructions so that warnings come before instruction (e.g. glue working time, arrows on sensors pointing down, the link to the video for the bottom part, encoder guide)
• Add Markdown paragraph breaks where there were new lines. I think that these were probably supposed to be line breaks but ended up as run-on paragraphs.

[panathea]

• We should add plyers to the tool list
• I converted the depanelizing video to a shorter gif and it's 3x the size...maybe worth just linking the video.

[scatterthought]

Great start! I think the only edit I'd make at this time is here:

"If you purchased upgraded sensors, you will have two sets of sensor boards and lenses. The longer lenses belong to the PAW3395 boards."

I'm not sure it's clear that the PAW3395 boards are the upgraded ones, so I would repeat it.

If you purchased the upgraded PAW3395 sensors, you will have two sets of sensor boards and lenses. Use the longer lenses for the PAW3395 boards."

[efogdev]

Do you guys need any photos from me?

[panathea]

It seems like people are breaking the encoder knobs. Do you have any advice on how to remove them from the packaging? I can also add a note that resin/SLA printed parts should be handled with care.

For photos, the following would be nice:

• A sensor board with a lens attached, with its FPC cable installed (similar to the existing one for the encoder board)
• The guide in a rotary encoder
• An assembled static bearing adapter, one shot showing the bearing and one showing the screw. (We could add a sentence advising to install it till its tight, then loosen the screw a few turns so that the bearing has some movement.)
• Assembly after the encoders are installed, but before the sensors are placed

One other broad question is that the guide makes no mention of the clever packaging—is that iterating constantly, or would it be worth surfacing what the packaging looks like, what each bit holds, and how to open them? E.g. it might be good to indicate that the upgraded sensors come in their own box.

[panathea]

Is this photo necessary, or could it be improved by showing a photo of the cable running through the motherboard slot?

[efogdev]

Packaging is indeed a subject to constant change, especially now that I have the upgraded sensors and dongles as parts of the kit.

Re: last photo; it actually wasn't there at first, but I added it after a few customers had their cables oriented/inserted incorrectly.

Re: everything else, will comment/respond in a few days, gotta fulfill those orders now...

[scatterthought]

I think we should focus on reducing content before starting to add, so that we can get closer to the essentials. That's why I mentioned favouring more links out to tutorials (e.g. heatset inserts) rather than trying to teach.

I've seen some build guides (particularly for keyboards) that are incredibly detailed, but so overwhelming that they turn people off immediately.

Ploopy's documentation is really good, because it provides a lot of structure that's easy to comprehend. Is that using Github Pages? (I'm very inexperienced with Github)

https://docs.github.com/en/pages/getting-started-with-github-pages/what-is-github-pages

[panathea]

It's an MkDocs page. There are several options for hosting with GitHub pages that could be used, I'd agree that the current GitHub Markdown view isn't ideal. There is an outline available for a TOC, but it's hidden behind a button click and doesn't support multiple levels:

We could add a table of contents generated at the top of the document itself. At the very at least, it would make jumping to particular sections easier.

[efogdev]

As I'm going to release a knowledge base really soon, let's defer this until then.