Sam da975d7375 docs: audit fixes -- retire stale claims, add navigation, correct init_db story
From a two-agent audit (docs accuracy + greenfield deploy path):

- init_db docs were describing upstream behavior: this repo's psql-app
  auto-creates the schema on first run and drops config/do_not_init_db to
  skip later (psql-app/scripts/run:74). README/DOCS/backup-restore now
  describe the marker semantics; the restore flow creates the marker
  BEFORE first start instead of 'not creating init_db'
- DOCS.md contained heavy retired-lab drift: banner declares it a legacy
  walkthrough with illustrative values; fixed its self-contradictions --
  external port 1790, folder OBMP-Reference, datasource 'PostgreSQL',
  OpenConfig gNMI paths (matching telegraf.conf), EXABGP_PEERS,
  TRAFFIC_GEN_PORT
- deploy.sh --help now shows the current scope names (old ones remain
  accepted aliases)
- navigation: new docs/README.md index with operator and network-engineer
  tracks (links the previously orphaned backup-restore, security-hardening,
  ROADMAP, DB_SCHEMA); README gains a Start-here router
- intra-docs prose paths no longer carry the docs/ prefix (they resolve
  from within docs/); RR-CLIENTS -> RR-CLIENT matches the blueprint;
  ROADMAP A6 marked done
- scripts/deploy-lib.sh added: shared log/ask/confirm/get_env/set_env
  helpers for the deploy tooling consolidation (wiring lands next)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-20 17:05:47 -07:00
..

Documentation index

Two tracks depending on who you are. Docs higher in each list are the entry points; the rest are references you'll be routed to when needed.

Operators — deploying and running the stack

Doc What it covers
../README.md Quickstart: clone, pin the checkout, run deploy.sh
DEPLOYMENT-TYPES.md The three --scope types (full-stack / remote / central-store) + burst sizing model
PORTABILITY-FINDINGS.md Every greenfield trap and how the tooling handles it — read before deploying to a new host
production-sizing.md Memory limits and host sizing for production
backup-restore.md Postgres backup/restore (scripts/pg-backup.sh)
security-hardening.md Hardening checklist for exposed deployments
DB_SCHEMA.md Full database schema reference (33 tables, views, query patterns)
ROADMAP.md Longer-term work items

Network engineers — feeding routers into the stack

Doc What it covers
router-integration.md Start here. The four ingest paths (BMP, BGP-LS, gNMI, NETCONF), bring-up order, verification
router-bmp-config.md BMP deep-dive: address/port selection (WSL vs native), activation scope, troubleshooting
../router-blueprints/ Copy-paste IOS-XR fragments with <PLACEHOLDER> substitutions

Legacy

Doc Status
DOCS.md Original single-host dev-lab walkthrough. Values are illustrative; where it disagrees with the docs above, they win.
handoff/ Point-in-time session handoff packets, kept for the record.