linuxboot / linuxboot/book

teeny tiny, but possibly important documentation mistake

Open
#199 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
300
Forks
54
PR merge metrics
No merged PRs in 30d

Description

https://github.com/linuxboot/book/blob/main/src/utilities/cpu.md?plain=1#L488

at the end of the sentence previous to this, an example using = is described, but the example linked above does not include that character.

Is the English description wrong, or is the example command wrong?

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

Open src/utilities/cpu.md around line 488 and compare the preceding sentence with the linked example command. Determine whether the prose or command is inconsistent, correct the mismatch, and confirm the surrounding documentation reads accurately.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.