diff options
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..6f5b79f --- /dev/null +++ b/docs/README.md @@ -0,0 +1,40 @@ +# Documentation index · MAX25-Stack 1.8.0 + +Compact doc map for MAX25 — start at MASTER-GUIDE for linear operator flow. + +## By role matrix + +| Role | Document | +|------|----------| +| Master operator guide | [MASTER-GUIDE.md](MASTER-GUIDE.md) | +| TNC / modem bring-up | [DEV/TNC-MODEM-DEV.md](DEV/TNC-MODEM-DEV.md) | +| Host setup | [LINUX-HOST-SETUP.md](LINUX-HOST-SETUP.md) | +| Device workflow | [PLUGINS-DEVICE-MODEL.md](PLUGINS-DEVICE-MODEL.md) | +| Terminal operator | [MAX25-TERMINAL.md](MAX25-TERMINAL.md) | +| Client / M25/1 | [MAX25-CLIENT.md](MAX25-CLIENT.md) | +| HyBBX integrator | [HYBBX.md](HYBBX.md) | +| BayCom / PC-COM | [BAYCOM.md](BAYCOM.md) | +| BayCom freeze warning (RX/TX) | [BAYCOM-FREEZES.md](BAYCOM-FREEZES.md) | +| TX/RX release test (TNC + BayCom/based) | [TX-RX-TEST.md](TX-RX-TEST.md) | +| Operator runbook | [MAX25-OPERATOR-RUNBOOK.md](MAX25-OPERATOR-RUNBOOK.md) | +| Contributor | [DEVELOPMENT.md](DEVELOPMENT.md) | + +## Technical reference matrix + +| Topic | Document | +|-------|----------| +| Architecture | [ARCHITECTURE.md](ARCHITECTURE.md) | +| Packet radio / AX.25 | [PACKET-RADIO.md](PACKET-RADIO.md) | +| CRDOP / SoftModem | [CRDOP.md](CRDOP.md) | +| Platforms | [PLATFORMS.md](PLATFORMS.md) | +| FreeBSD port | [FREEBSD-AX25.md](FREEBSD-AX25.md) | +| Modular TCP/IP | [MODULAR-TCPIP-SERVER.md](MODULAR-TCPIP-SERVER.md) | +| v1 scope | [V1.0.0-SCOPE.md](V1.0.0-SCOPE.md) | +| v2 goals | [V2.0.0-SCOPE.md](V2.0.0-SCOPE.md) | + +## Related + +| Goal | Doc | +|------|-----| +| Root README | [../README.md](../README.md) | +| Release gates | [../RELEASE-READINESS.md](../RELEASE-READINESS.md) | |