Repository navigation
Align documentation with current code, clarify bounds, and add troubleshooting - #4
Merged
Merged
Conversation
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
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.
Problem and resulting guidance
The guides mixed canonical and preferred AI entrypoints, treated below-profile targets as unavailable, implied whole-bundle resource/transaction guarantees, and omitted the actual collector API and sidecar semantics. This documentation-only revision checks current main (
1b513b8) and makes those contracts explicit: prefercontext.ai.json, preserve baseline/profile selection, distinguish incomplete observations, and scope byte limits and directory/archive failure separately.Rewrite and organize README, FORMAT, COLLECTORS, CONTRIBUTING, SECURITY and the threat model; add TROUBLESHOOTING; preserve historical audit/changelog context with exact revision/CI references; update bug/feature/PR templates. The catalog covers all 25 collectors and profile settings; the contributor guide includes executable metadata/detection/acquisition and helper signatures. Runtime and test code are unchanged.
The review also found a remaining code limitation:
run_owner_capture/probe_owner_capturestill select BusyBox setpriv by presence although publication feature-checks it. Optional per-user probes may fail under sudo without runuser. The guides document the exact affected boundary rather than claiming the previous Alpine handoff test proves all owner probes work. Fixing that code is outside this documentation revision.Validation
make check: all 31 regression scripts passed locally.bash tests/smoke-distribution.sh: all four profiles passed archive/manifest/AI/privacy/budget checks.git diff --checkpassed. Local tests run in the existing restricted namespace; they do not establish every live hardware/session configuration.