Documentation update: Highlight differences in x230 boards
Nobody has claimed this yet.
- Dominant language
- Makefile
- Stars
- 1.6k
- Forks
- 211
- Avg merge
- 4d 21h
- Merged PRs (30d)
- 6
Description
Hello,
I have difficulties to understand the differences of the available x230 boards. In https://github.com/osresearch/heads-wiki/edit/master/Installing-and-Configuring/Prerequisites.md three boards namely `x230`, `x230-hotp-verification` and `x230-flash` are listed. However, looking at https://github.com/osresearch/heads/tree/master/boards five boards are listed: `x230-flash`, `x230-hotp-maximized`, `x230-hotp-verification`, `x230-maximized` and `x230`
What are the differences between them? Why are only three boards mentioned in documentation? Looking at the boards config files does not help unexperienced users. It would help, if there was more detailed documentation about the differences and which board one has to build depending on what devices (e.g. Nitrokey Pro etc.) one wants to use. I will update the config files of each board and the documentation if someone answers.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with Installing-and-Configuring/Prerequisites.md and compare it with the five board configurations under boards. Determine the differences and supported devices, including Nitrokey Pro, then update the configuration descriptions and documentation so all boards and their intended uses are covered.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, embedded-iot
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100