linuxboot / linuxboot/heads-wiki

Notes on the instructions during the first configuration with a less technical eye.

Open
#146 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
96
Forks
58
Avg merge
1d 16h
Merged PRs (30d)
11

Description

I leave my comments, from my first exposure to the manual:

[Prerequisites for Heads](https://osresearch.net/Prerequisites):
- The mention of what TOTP/HOTP is at the end in the [Current Maximized boards ](https://osresearch.net/Prerequisites#current-maximized-boards)section. I think this could be mentioned earlier, in a separate subsection at the very beginning of the document.
- There is no mention that HEADS allows you to check the integrity of your computer, and does not block it. The word "key" connotes the ability to unlock something. People associate TOTP with 2FA, which blocks access and only verifies whether both numbers are the same.
- Maybe, in the future, as less technical stuff comes together, separate `Introduction` from [Prerequisites for Heads](https://osresearch.net/Prerequisites).

[Step 2 - Flashing Guides](https://osresearch.net/Flashing-guides)
- It seems to me that the `Purism` instruction should be under the Table of Contents, and have the heading `Purism Librem platform`. The current website design is different from the others.

[Step 3 - Configuring-Keys](https://osresearch.net/Configuring-Keys/)
- There is a moment where `Answer the prompts properly:` not everything has to be clear to someone less familiar. Explaining the process as [here](https://osresearch.net/Configuring-Keys/#process) is helpful.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Prerequisites for Heads, Flashing Guides, and Configuring Keys pages, comparing the current headings and explanatory flow with the requested changes. Review the existing process section before revising the explanation around “Answer the prompts properly.” Done means the requested TOTP/HOTP context, integrity clarification, Purism heading and placement, and clearer configuration guidance are reflected in the documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.