docs/README.md

# cabletest docs

Project knowledge that moves and versions with the repo.

General:

- [goals.md](goals.md) — what cabletest is for and what it must output.
- [state.md](state.md) — where things are now: committed vs stashed, the box and what's in it, bringup progress, open items. **All current-placement state lives here and only here.**
- [hardware.md](hardware.md) — host rules: interface conventions, tuning, how to run.
- [measurement.md](measurement.md) — how to measure correctly; performance results and dead ends.
- [open-questions.md](open-questions.md) — the open problems, with their current answers.

Per-device (each directory: device doc + its datasheets):

- [nics/](nics/README.md) — the transport rule, the comparison table, and one directory per NIC: [x520](nics/x520/README.md), [connectx-5](nics/connectx-5/README.md), [x710](nics/x710/README.md), [e810](nics/e810/README.md), [wx1820](nics/wx1820/README.md).
- [modules/](modules/README.md) — module inventory, media-lies table, the shared IEEE register set, RollBall protocol, cable-length physics, and one directory per module: [fs](modules/fs/README.md), [wiitek](modules/wiitek/README.md), [fibergaga](modules/fibergaga/README.md).
Add in-repo project docs: goals, state, hardware, module-PHY transports, module diagnostics, and measurement lessons 2026-08-10 10:34:26 -07:00			`# cabletest docs`

			`Project knowledge that moves and versions with the repo.`

Restructure docs: per-device directories under modules/ and nics/ with co-located datasheets, state centralized in state.md, prose tightened into lists and tables 2026-08-12 19:23:02 -07:00			`General:`

Add in-repo project docs: goals, state, hardware, module-PHY transports, module diagnostics, and measurement lessons 2026-08-10 10:34:26 -07:00			`- [goals.md](goals.md) — what cabletest is for and what it must output.`
Restructure docs: per-device directories under modules/ and nics/ with co-located datasheets, state centralized in state.md, prose tightened into lists and tables 2026-08-12 19:23:02 -07:00			`- [state.md](state.md) — where things are now: committed vs stashed, the box and what's in it, bringup progress, open items. All current-placement state lives here and only here.`
			`- [hardware.md](hardware.md) — host rules: interface conventions, tuning, how to run.`
Add in-repo project docs: goals, state, hardware, module-PHY transports, module diagnostics, and measurement lessons 2026-08-10 10:34:26 -07:00			`- [measurement.md](measurement.md) — how to measure correctly; performance results and dead ends.`
Restructure docs: per-device directories under modules/ and nics/ with co-located datasheets, state centralized in state.md, prose tightened into lists and tables 2026-08-12 19:23:02 -07:00			`- [open-questions.md](open-questions.md) — the open problems, with their current answers.`

			`Per-device (each directory: device doc + its datasheets):`
Add in-repo project docs: goals, state, hardware, module-PHY transports, module diagnostics, and measurement lessons 2026-08-10 10:34:26 -07:00
Restructure docs: per-device directories under modules/ and nics/ with co-located datasheets, state centralized in state.md, prose tightened into lists and tables 2026-08-12 19:23:02 -07:00			`- [nics/](nics/README.md) — the transport rule, the comparison table, and one directory per NIC: [x520](nics/x520/README.md), [connectx-5](nics/connectx-5/README.md), [x710](nics/x710/README.md), [e810](nics/e810/README.md), [wx1820](nics/wx1820/README.md).`
			`- [modules/](modules/README.md) — module inventory, media-lies table, the shared IEEE register set, RollBall protocol, cable-length physics, and one directory per module: [fs](modules/fs/README.md), [wiitek](modules/wiitek/README.md), [fibergaga](modules/fibergaga/README.md).`