Skip to content

ArcDeterministic ESP32-S3 firmware substrate

Typed ownership, explicit DMA/cache boundaries, static Core 0/Core 1 composition, and benchmarked hot paths on ESP-IDF.

Choose The Next Page

Use this map before opening the full API reference.

If you need to...Go hereWhy
build Arc for the first timeGetting Startedenvironment, first build, local checks, and the shortest reading path
understand why Arc splits Core 0 and Core 1Architectureownership model, realtime limits, DMA/cache rules, and profile boundaries
write the first safe ownership contractSafety Patternscopyable static-lifetime, core-owner, loan-pack, and proof-pack patterns
move from example firmware to a product treeProduction IntegrationCMake shape, target policy, board topology, validation ladder, and release evidence
diagnose a build, editor, docs, benchmark, or evidence failureTroubleshootingsymptom-first fixes for target setup, CMake, clangd, VitePress, repo policy, and claims
decode Arc-specific wordsGlossaryshort definitions for Core 0/Core 1, ownership, DMA/cache, target, evidence, protocol, and licensing terms
choose the right headerModule Guideproblem-first groups for every public Arc header
open one header page directlyModule Page Indexgenerated per-header pages with fit, CMake, source landmarks, and proof path
find exact public names and behaviorAPI Referencemethod-level notes mirrored from the source-backed README
pick firmware to buildExamplesone table for ESP32-S3 examples, portable examples, and ESP32-S31 scaffolds
follow contribution, review, and release policyGovernancecontribution path, PR/issue templates, CODEOWNERS, release evidence, and notice policy
understand repository security handlingSecurity Automationdisclosure policy, CodeQL scanning, Dependabot update scope, and release-time human review duties
decide license pathLicensingArc public AGPL path and paid commercial policy
publish performance claimsBenchmarkingevidence levels and reporting rules

First Fifteen Minutes

  1. Run source ./env.sh.
  2. Build idf.py -C examples/esp32s3/udp build.
  3. Read Architecture to understand Core 0 service work versus Core 1 deterministic work.
  4. Read Safety Patterns before writing shared state or cross-core handoff code.
  5. Read Production Integration before moving code into a product tree.
  6. Use Module Guide to choose the smallest header for your problem.
  7. Read Governance before opening a pull request or preparing a release artifact.
  8. Read Security Automation and root SECURITY.md before relying on CI status for release evidence.
  9. Open that header in Module Page Index, then check exact names in API Reference.

Documentation Shape

Arc docs are arranged from decision to evidence:

  • start pages explain where to go next;
  • safety patterns turn the ownership model into copyable code shapes;
  • module pages map headers to purpose, dependency, and proof path;
  • integration docs connect target policy, CMake shape, board topology, and evidence level;
  • troubleshooting keeps common setup, build, editor, site, and evidence failures actionable;
  • governance links contribution, review, ownership, release, security, and notice controls;
  • security automation documents the disclosure policy, CodeQL, Dependabot, and the human release checks that CI cannot prove;
  • the glossary keeps Arc vocabulary consistent across the README, site, and generated pages;
  • examples show the buildable firmware surface;
  • API pages keep exact names and ownership behavior available without reading the whole README;
  • benchmarking, safety, and licensing pages state the rules before claims are published.

ESP32-S3 first. ESP-IDF native. Static ownership by default.