Files
SirHumza--orbisRPC/docs/README.md
T
SirHumza 481b836893 docs: delete HANDOFF, merge findings into docs/research, expand
- Delete stale HANDOFF.md (superseded by PRODUCTION + README + CI)
- Move findings/ into docs/research/ (incl retired-tables); fix
  all cross-links (DAEMON, injecting, README, fw.h, PROGRESS_LOG)
- New docs/README.md index; new BUILDING.md (toolchain, SDK rule,
  scripts, CI jobs, tests); new CONFIG.md (full key reference,
  verified against cfg_defaults)
- Rewrite TROUBLESHOOTING.md from tester history (first-run flow,
  nanoDNS 127.0.0.1 step, connection checklist, known issues)
- INSTALLER.md: PKG not shipped with test builds; PRODUCTION.md:
  drop dead-webhook line, fix readiness note
2026-10-06 19:55:17 +02:00

1.9 KiB

orbisRPC docs

Start at the repo README (install, support, config basics). This folder is the deep end: design, building, and hardware research.

For testers

  • TROUBLESHOOTING.md — every known failure, symptom first: no presence, ? tile, token rejected, payload won't start, DNS.
  • CONFIG.md — every config.json key, defaults, what the show_* flags actually hide.

For developers

  • DAEMON.md — loop, states, detection, names, art, sessions.
  • BUILDING.md — toolchain, SDK-from-git rule, scripts, CI jobs, host tests.
  • INSTALLER.md — Setup PKG design (ships with the official release, not with test builds).
  • injecting.md — getting payloads onto the console, loaders, the one-shot rule.
  • PRODUCTION.md — production-readiness report: what was verified on hardware, what is still open.

Hardware research archive

research/ — findings earned on a real console. Every claim was observed unless marked THEORY.