Repository navigation
docs: align setup and component references with implemented behavior - #23
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.
What
Complete the approved 23-file documentation-only audit in three focused commits:
c199f02— correct setup, platform and research-evidence guidance (9 files).a9b6d99— complete component contracts and verification references (11 files).654c154— reconcile navigation and record the full documentation audit (3 files).The change consists of 18 Markdown files and five Python files with docstring-only edits. No runtime logic, dependencies, tests, public APIs or measured artifacts changed.
Why
Align the documentation with the implemented source: disclose native macOS wheel incompatibility, distinguish frozen-benchmark requirements from explicitly authorized operating-validation exploration, document existing data/model/attack/evaluation and HTTP contracts, and clarify historical MNIST ASR semantics without changing scores.
The complete inventory, findings, file-by-file changes, open questions and prioritized follow-ups are in
docs/documentation_audit.md.How tested
make lint— passed before each commit; pre-commit hooks also passed.make test— 468 passed, 6 expected skips; rerun viamake checkbefore publication.make coverage— 88%, unchanged from baseline.make security— no known audited vulnerabilities or medium/high Bandit findings.make demo— intentionally not run; historical generated evidence preserved.make docker-buildpassed after each editing batch, using cached dependency layers.git diff --check.Not rerun: fresh installation, Windows/macOS execution, real-data opt-ins or experiments, optional CleverHans calls, Compose startup, Trivy, graphical-browser/end-to-end/load checks, remote CI, or exhaustive scholarly/external-link validation. Six skips are three real-data opt-ins and three absent CleverHans cases. Existing third-party deprecation warnings remain.
Checklist
Deferred decisions
Native macOS support and authorized MNIST evidence regeneration remain owner decisions. The potential optional CleverHans gradient-context issue and the missing research-page overview target are flagged for separate code work, not changed here.