doc: add missing developer docs pulled from wiki#2079
Open
tlaurion wants to merge 2 commits intolinuxboot:masterfrom
Open
doc: add missing developer docs pulled from wiki#2079tlaurion wants to merge 2 commits intolinuxboot:masterfrom
tlaurion wants to merge 2 commits intolinuxboot:masterfrom
Conversation
…l, gpg Pull wiki content (osresearch.net) into the repo as doc/*.md files so documentation and code live together. Five files that had no local counterpart: - keys.md: all key/secret types, PCR map, LUKS derivation, unseal errors - configuring-keys.md: OEM Factory Reset / Re-Ownership step-by-step guide - prerequisites.md: USB dongle compatibility table, HOTP vs TPMTOTP, OS requirements - recovery-shell.md: limitations, common operations, post-recovery checklist - gpg.md: key generation paths, PIN management, full card reset, NK3 notes Terminology updated throughout to match current code: TPM Owner Passphrase (not password), GPG Admin/User PIN, Diceware references. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Thierry Laurion <insurgo@riseup.net>
… in bug reports - doc/development.md: commit format (-S -s, imperative, component prefix), Co-Authored-By policy, doc/*.md vs heads-wiki split, build artifact quick reference, testing checklist, shell/UX coding conventions - bug report template: prompt reporters to include the exact ROM filename as the primary build identifier (encodes timestamp, branch, commit) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Thierry Laurion <insurgo@riseup.net>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Pulls developer-facing content from osresearch.net into
doc/*.mdso documentation and code live together and are reviewed/versioned the same way.Seven files added or updated:
doc/keys.mddoc/configuring-keys.mddoc/prerequisites.mddoc/recovery-shell.mddoc/gpg.mddoc/development.md.github/ISSUE_TEMPLATE/bug-report-…Terminology updated throughout to match current code: passphrase for TPM/LUKS secrets, PIN for GPG smartcard (OpenPGP spec), never "password" in user-facing text.
No code changes
This PR is documentation only — no shell scripts, Makefile, or config files are modified.
Test plan
🤖 Generated with Claude Code