Repository navigation
docs: clarify setup, desktop support, and delivery workflows - #511
Merged
Merged
Conversation
Put task navigation and setup first while retaining detailed security contracts in the desktop guide. Update metadata and documentation assertions for the supported installer and fictional preview distinction. Documentation-only change: application behavior, architecture, and threat-model boundaries are unchanged; no failing application behavior test applies. The documentation regression suite passes all 296 tests.
Present the authoritative Codex review procedure as ordered steps and explicit delivery stops. State that every unclassified tracked path fails the documentation inventory, including non-comment formats. Preserve review identity, revision, resolution, and security invariants. Documentation-only clarification; implementation and architecture are unchanged. Relevant documentation regression tests pass.
Document the required dispatch inputs, capture the returned run URL, and verify workflow identity, candidate SHA, completion, and downloaded evidence before continuing. Use the repository virtual environment for release recovery verification. Preserve lifecycle audit and release provenance requirements. Shell examples pass bash syntax checks and match the workflow and publication contracts. Documentation-only; no workflow was dispatched and no application behavior changed.
github-actions
Bot
added
documentation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
sodejm
enabled auto-merge (squash)
October 14, 2026 01:39
Owner
Author
|
@codex review |
|
Codex Review: Didn't find any major issues. Keep them coming! Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
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
Make the documentation's setup, desktop support, navigation, contributor review, and release procedures usable without weakening the existing security or support boundaries.
Acceptance criteria
tests/test_desktop_learning_path_docs.py,tests/test_desktop_architecture_docs.pytests/test_release_contract.py; shell syntax and workflow/checker contract reviewmake docs-cutover; wiki and Pages contract teststests/test_code_review_skill_contract.py; comparison with trusted-base skilltests/test_code_documentation_policy.py;make code-docs-checkTDD evidence
No behavioral test applies because this change updates documentation and its location-sensitive contract assertions without changing application or workflow behavior. Existing support and security assertions remain enforced. The focused documentation regression suite passed all 296 tests.
Validation evidence
make markdown-checkmake docs-cutovermake code-docs-check.venv/bin/python scripts/validate_wiki_docs.py --source docsbash -nand local implementation comparisongit diff --check origin/main..HEADmake pre-pushmake docs-screenshots-checkDOCSHOT_ELECTRON_PLATFORM_UNSUPPORTED; hosted Ubuntu 24.04 x86_64 CI supplies canonical PNG drift validationmake workflow-auditRisk and safety
Low risk. No runtime, API, dependency, architecture, or threat-model changes. Architecture and threat-model documents are unaffected because this patch clarifies existing behavior and boundaries. No release artifact is produced or altered.
Provider
noneremains network-free, cloud use still requires explicit selection and consent, the sidecar remains private and authenticated, and immutable RootsMagic/GEDCOM protections remain unchanged. Named provider, Tasks, Chat, and file-grant functionality remains gated on target-matched evidence. No secrets or private genealogy data are included.The branch was created from current
origin/main, uses the requiredbugfix/*prefix, and contains four signed commits. Hosted signature verification, CI, and exact-target Codex review will be checked before merge.