docs(parity): at-a-glance, verify checklist, support/validation matrices, generated-files table - #2242
Draft
thinmintdev wants to merge 1 commit into
Draft
docs(parity): at-a-glance, verify checklist, support/validation matrices, generated-files table#2242thinmintdev wants to merge 1 commit into
thinmintdev wants to merge 1 commit into
Conversation
…erated-files table Adds the parity-docs deliverables for the hal0 x ODS parity program: - README: an "At a glance" summary block and an if-you-know-Ollama/ llama.cpp/Open WebUI/LocalAI comparison table, near the top. - docs/getting-started/verify.mdx: the six-step post-install checklist (health, model list, first chat, dashboard, logs, doctor), each step with its command and what a good answer looks like. Cross-linked from install.mdx's existing "Verify the install" section and the getting-started index card grid. - docs/reference/support-matrix.mdx: what hal0 supports today, deriving every row from the CI workflows, installer/lib/distro.sh, and the release-validation fleet (tests/release-validation/) rather than restating aspirational claims. Distinguishes installer-level package-manager detection from what CI and the fleet actually exercise. - docs/reference/validation-matrix.mdx: the alpha/beta/gamma test tiers and the rc-validate release-validation kit mapped onto release-gate vocabulary, plus a "User Green" definition adapted to hal0 (a fresh box reaching first chat unattended). - docs/reference/generated-files.mdx: every file hal0 generates or rewrites, its writer (file:line), when it's rewritten, and whether operator edits survive. Cross-linked from paths-and-files.mdx, which owns *what* each path is for. - CONTRIBUTING.md: an area -> required-validation table mirroring the PR template's Sec 14.1 high-risk map. While fact-checking the validation-matrix and support-matrix drafts against source, found that CONTRIBUTING.md's beta integration tier (make test-integration, .github/workflows/integration.yml, tests/slots/test_integration.py) was retired in the toolbox-retirement pass and never restored, despite that commit's own message naming a follow-up that would. Filed as #2239 rather than silently documented around; both new reference pages and the CONTRIBUTING.md table state the current (missing) reality instead of repeating the stale claim. Docs-only; no code changes. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RPrCENafeE5LZB4P1VCCST Signed-off-by: thinmintdev <alexander@awideweb.com>
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
Adds the parity-docs deliverables from the hal0 × ODS parity program's
"at-a-glance / post-install checklist / support & validation matrices /
generated-config-writers table" brief: a README "At a glance" block and
comparison table, a six-step post-install verify page, a support matrix,
a validation matrix (mapping hal0's α/β/γ tiers and the
rc-validaterelease-validation kit onto a hal0-specific "User Green" definition), a
generated/rewritten-files reference (writer, rewrite trigger, and whether
operator edits survive, per file), and a CONTRIBUTING.md area→required-
validation table mirroring the PR template's §14.1 high-risk map. Every
fact is verified against the current source tree (file:line citations
inline in the new pages) — no ODS text is copied, only the structural
idea of each page. Docs-only; no code changes.
Risk grade
Touched surfaces
src/hal0/api/)src/hal0/auth/, login routes, middleware)src/hal0/slots/,slot_state,/v1/load|unload)src/hal0/capabilities/,model_meta,model_fit)installer/, systemd units)src/hal0/updater/,hal0.releases.v1manifest)src/hal0/api/routes/board_chat.py,src/hal0/mcp/admin.py)src/hal0/config/, pydantic models)ui/src/, Playwright specs)docs/,CONTRIBUTING.md).github/workflows/,release.yml)§14.1 high-risk surfaces
AUTONOMOUS_WRITE_TOOLSadditionsNone apply — this PR touches no code.
Rollback
Rollback: revert the merge commit; every change is additive documentation plus two CHANGELOG/CONTRIBUTING edits, no code or config behavior changes.
Test tiers run
make test) — not applicable, no code changedmake test-integration) — not applicable, no code changedmake release-test) — not applicable, no code changedVerification performed instead: every CLI command, file path, function
name, and
file:linecitation in the new/changed pages was checkedagainst the current tree (not memory) while writing, and a follow-up
docs-verifierpass fact-checked the full claim list against sourcebefore this PR was opened.
python3 scripts/check_sunset.pyis green(no code touched).
🤖 Generated with Claude Code
https://claude.ai/code/session_01RPrCENafeE5LZB4P1VCCST