Skip to content

docs: align setup and component references with implemented behavior - #23

Merged
mohamed2ze merged 3 commits into
mainfrom
sprint5/attacks-dashboard-handoff
Nov 17, 2026
Merged

mohamed2ze merged 3 commits into
mainfrom
sprint5/attacks-dashboard-handoff

Conversation

@mohamed2ze

Copy link
Copy Markdown
Collaborator

What

Complete the approved 23-file documentation-only audit in three focused commits:

  1. c199f02 — correct setup, platform and research-evidence guidance (9 files).
  2. a9b6d99 — complete component contracts and verification references (11 files).
  3. 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 via make check before publication.
  • make coverage — 88%, unchanged from baseline.
  • make security — no known audited vulnerabilities or medium/high Bandit findings.
  • Isolated synthetic demo/model tests — included in the full suite; 12 dataset-free library examples also executed.
  • make demo — intentionally not run; historical generated evidence preserved.
  • make docker-build passed after each editing batch, using cached dependency layers.
  • Verified all eight CLI help commands, six JavaScript syntax checks, environment pins, HTTP artifact/pending/docs-disable/disabled-prediction contracts, and documented read-only clients.
  • Verified links, 32 supplemental Markdown fragment targets, fence/table structure and git diff --check.
  • All five Python ASTs are identical after docstring removal; every tracked result, figure and data manifest remains byte-identical to the audited baseline.

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

  • Conventional Commits title
  • No datasets/weights/.env/mlruns committed
  • Security-impacting changes reviewed — not applicable; no security behavior changed, and existing gates remain intact
  • Docs updated; no new architectural decision or dependency change
  • Docs discoverability, dependency boundaries and generated-file rules preserved

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.

@mohamed2ze
mohamed2ze merged commit 1249001 into main Nov 17, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant