docs: sync runtime contracts and Symbolics workflow #89

Open

nsaspy wants to merge 8 commits from docs/sync-runtime-contracts-20260902 into main

nsaspy commented

2026-09-04 20:11:14 +00:00

Owner

Summary

Audit the human-facing and source-adjacent documentation against the current a0-symbolics runtime and remove source/doc drift.

Fixed

document the actual API dispatcher contract: built-in handlers are served under /api/<handler>
correct stale external API labels from root-level /api_* to /api/api_*
keep the WebUI External API reference labels consistent with its already-correct executable fetch() examples
document the current api_message payload, including agent_profile
correct chat storage from /usr/chats to /a0/usr/chats/
add a repository-native A0 Symbolics Runtime guide based on scripts/symbolics, the Compose example, healthcheck, and current API router
link the Symbolics runtime guide from the docs hub and quickstart
make the route construction rule explicit in helpers/api.py.dox.md so filename-derived docs do not drop the dispatcher prefix again

Source checked

helpers/api.py
api/api_message.py
api/api_log_get.py
api/api_terminate_chat.py
api/api_reset_chat.py
api/api_files_get.py
api/health.py
scripts/symbolics
launch.sh
docker/symbolics/compose.yml.example
docker/symbolics/healthcheck.sh
current WebUI External API examples

Verification

branch is based exactly on main 044537063e05354cd30fc66645ccc3fee435338c
diff is documentation/reference-only; no backend runtime behavior changed
preserved the executable External API example JavaScript while updating its visible docs
no merge performed; CI/review should gate this PR

## Summary Audit the human-facing and source-adjacent documentation against the current `a0-symbolics` runtime and remove source/doc drift. ### Fixed - document the actual API dispatcher contract: built-in handlers are served under `/api/<handler>` - correct stale external API labels from root-level `/api_*` to `/api/api_*` - keep the WebUI External API reference labels consistent with its already-correct executable `fetch()` examples - document the current `api_message` payload, including `agent_profile` - correct chat storage from `/usr/chats` to `/a0/usr/chats/` - add a repository-native `A0 Symbolics Runtime` guide based on `scripts/symbolics`, the Compose example, healthcheck, and current API router - link the Symbolics runtime guide from the docs hub and quickstart - make the route construction rule explicit in `helpers/api.py.dox.md` so filename-derived docs do not drop the dispatcher prefix again ## Source checked - `helpers/api.py` - `api/api_message.py` - `api/api_log_get.py` - `api/api_terminate_chat.py` - `api/api_reset_chat.py` - `api/api_files_get.py` - `api/health.py` - `scripts/symbolics` - `launch.sh` - `docker/symbolics/compose.yml.example` - `docker/symbolics/healthcheck.sh` - current WebUI External API examples ## Verification - branch is based exactly on main `044537063e05354cd30fc66645ccc3fee435338c` - diff is documentation/reference-only; no backend runtime behavior changed - preserved the executable External API example JavaScript while updating its visible docs - no merge performed; CI/review should gate this PR

nsaspy added 8 commits

2026-09-04 20:11:14 +00:00

docs: sync external API routes with dispatcher 62c3edf255

docs: fix Symbolics quickstart paths 7d28ee3e86

docs: add Symbolics runtime guide 481dfbbd7d

docs: index the Symbolics runtime guide a8f3ecb431

docs: make API dispatcher route contract explicit a89b36cd75

docs: sync api_message DOX with runtime contract 7b93507b24

docs: sync External API example labels with runtime f55f9be49c

fix: preserve executable API example JavaScript 86b9d6d795

This pull request can be merged automatically.

This branch is out-of-date with the base branch

You are not authorized to merge this pull request.

View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u origin docs/sync-runtime-contracts-20260902:docs/sync-runtime-contracts-20260902

git switch docs/sync-runtime-contracts-20260902

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git switch main

git merge --no-ff docs/sync-runtime-contracts-20260902

git switch docs/sync-runtime-contracts-20260902

git rebase main

git switch main

git merge --ff-only docs/sync-runtime-contracts-20260902

git switch docs/sync-runtime-contracts-20260902

git rebase main

git switch main

git merge --no-ff docs/sync-runtime-contracts-20260902

git switch main

git merge --squash docs/sync-runtime-contracts-20260902