README_EN.md

OGScope documentation index

English | 中文

Start here

• New to the project / first run: A Getting started.
• Board networking, hotspot, plate DB, stability, BOM: B Board ops.
• API, contracts, architecture, tests, pre-commit checklist: C API and quality.
• External integration (subordinate mode, delegated sensors): D External integration.
• Debug console and contributing: E Tools and contributing.

A Getting started

• Quick Start Guide | 中文
• Development Guide (board deployment) | 中文

B Board ops

• WiFi / NetworkManager | 中文
• Plate-solve data (inline bilingual sections)
• Service stability / memory (inline bilingual sections)
• Hardware BOM | 中文

C API and quality

• API layering, FastAPI entry, directory layout | 中文
• System architecture (bilingual single doc)
• Core REST v1 | 中文
• Dev REST v1 | 中文
• Core compatibility matrix (inline bilingual sections)
• Architecture Quick Checklist | 中文
• Testing guide | 中文

D External integration

• Subordinate runtime mode | 中文
• Hardware Plane UDS v1 (delegated sensors) | 中文
• Core REST v1 | 中文 (primary integrator entry)

E Tools and contributing

• Debug console | 中文
• Contributing | 中文