docs: add complete Agent and HTTP API tutorials - #3
Draft
Teingi wants to merge 5 commits into
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Which issue or RFC does this PR close?
No linked issue or RFC.
Rationale for this change
PowerContext users do not all enter through an Agent Host. Some use Codex, Claude Code, DSH, OpenCode, or another
supported Agent. Others already have an AI application and need one language-neutral, end-to-end HTTP learning path
that goes beyond Memory CRUD.
This change makes both entry points explicit. The direct-API path now follows one coherent AI engineering-assistant
scenario across evidence capture, request-time context, work continuity, Experience and Skill evolution, Review, and
operational reporting. It also keeps identity, scope authorization, write policy, and execution authority outside the
model.
What changes are included in this PR?
Experience, managed Skill, Candidate Review, External Skill Registry, Stats, and Handoff Report.
curlandjqflows for exact Source, Artifact, Memory citation, Candidate version, and Handoffrevision handling, including optimistic-concurrency and idempotency boundaries.
request without exposing Server credentials or caller-selected scopes to the model.
Candidates, human Review, approved immutable revisions, recall, usage-based replacement, and explicit publication.
Projects, Workstreams, Activities, retention, and Workspace bindings.
and a non-Codex DSH-to-OpenCode exact-Handoff continuation.
READMEs with the Agent and complete direct-API learning paths.
Are there any user-facing changes?
Yes. Users who already have an AI application can now open a single complete HTTP tutorial from the website or README
and follow PowerContext from installation through production authorization and operations. Agent users retain a
separate step-by-step entry that maps each Host to its actual Memory and Handoff surface.
The tutorial explicitly states that
scope_idis partitioning rather than authorization, PreparedContext is untrustedhistorical data, Candidate approval is a human-controlled CAS transition, and approved Skill content grants no tool,
file, network, secret, execution, or publication authority. There are no HTTP contract, persisted-format, package, or
runtime behavior changes.
How was this change tested?
make docs-test— strict Zensical build completed withNo issues foundfor the final bilingual site..venv/bin/prek run --files <15 changed paths>— all applicable repository hooks passed, including TOML,whitespace, merge/case checks, and
ty check..venv/bin/pytest tests/test_api_contract.py -q -p no:cacheprovider—26 passed, validating the canonical OpenAPIpaths and transport models used by the tutorial.
bashcode fences both passedbash -n;git diff --checkandgit diff --cached --checkpassed.affected test. The available system Python 3.11 environment lacked
rfc8785and OpenTelemetry dependencies, so thatfallback was not counted as a pass. GitHub's Python 3.11-3.14 matrix is running on the pushed head.
originbefore push and verified local, upstream, and PR head identity after publication.AI usage statement
OpenAI Codex (GPT-5) was used for repository inspection, documentation drafting, contract comparison, and validation.
The final commands, request/response shapes, trust boundaries, Agent capabilities, and workflows were checked against
the current OpenAPI source, Runtime implementation, integration documentation, tests, and strict site build.