Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.airglow.cc/llms.txt

Use this file to discover all available pages before exploring further.

This is a planning draft. Do not treat these pages as SDK documentation or API guarantees.
The SDK documentation should be written after the SDK contract is frozen and reconciled with the runtime implementation.

​
Planned page set

PageScopeSize
App modelWhat an app is and where code livesMedium
Runtime contextsUserscript, UI, startup, and server boundariesMedium
ManifestManifest schema and validation rulesLarge
SDK APIMethod-level browser SDK referenceLarge
Server RPCServer functions, payloads, errors, and secretsMedium
Security and permissionsPermission model, secrets, review checklistLarge
Local debuggingFirst-run diagnosis and developer inspection flowMedium

​
Before writing

  • Freeze the SDK contract.
  • Compare the contract with the runtime implementation.
  • Compare the contract with generated TypeScript declarations.
  • Decide which examples are stable enough to publish.
  • Keep non-final behavior out of the public docs.

​
Estimated volume

The first useful SDK docs pass is roughly 7 pages. The large pages are Manifest, SDK API, and Security and permissions; those should wait until the spec is stable.