Skip to content

Commit 5157c12

Browse files
committed
Document AppKit context surface
1 parent 10bbd77 commit 5157c12

3 files changed

Lines changed: 37 additions & 1 deletion

File tree

guides/context_abi.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# AppKit Context ABI Surface
2+
3+
AppKit owns product-safe context, model, evaluation, cost, replay,
4+
optimization, coordination, and operator projections. It is the only supported
5+
product boundary for governed NSHKR writes and reads.
6+
7+
## Public Surface
8+
9+
`core/context_surface` exposes product-safe context packet and AI run summaries.
10+
It depends on Mezzanine projections and redacted refs, not direct calls into
11+
OuterBrain, Citadel, Jido Integration, or AITrace internals.
12+
13+
## Boundary Rules
14+
15+
Product code must not import lower owner packages to compile context, render
16+
prompts, execute models, or inspect raw trace payloads. AppKit returns bounded
17+
summary DTOs with context packet refs, authority refs, model invocation refs,
18+
eval refs, cost summaries, replay refs, and safe projection state.
19+
20+
## Local QC
21+
22+
```bash
23+
mix ci
24+
```
25+
26+
StackLab proves that product paths enter through AppKit and do not bypass the
27+
lower owner boundaries.

guides/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
Implementation-facing guides:
44

55
- [Generalized Stack Boundary](https://github.com/nshkrdotcom/app_kit/blob/main/guides/generalized_stack.md)
6+
- [Context ABI Surface](context_abi.md)
67
- [Code Smell Remediation](code_smell_remediation.md)
78
- [QC And Operations](https://github.com/nshkrdotcom/app_kit/blob/main/guides/qc_and_operations.md)
89

mix.exs

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,9 @@ defmodule AppKit.Workspace.MixProject do
148148
"docs/layout.md",
149149
"docs/surfaces.md",
150150
"docs/composition.md",
151+
"guides/context_abi.md",
152+
"guides/generalized_stack.md",
153+
"guides/qc_and_operations.md",
151154
"guides/code_smell_remediation.md",
152155
"CHANGELOG.md",
153156
"LICENSE"
@@ -156,7 +159,12 @@ defmodule AppKit.Workspace.MixProject do
156159
Overview: ["README.md", "docs/overview.md"],
157160
Architecture: ["docs/layout.md", "docs/surfaces.md"],
158161
Composition: ["docs/composition.md"],
159-
Guides: ["guides/code_smell_remediation.md"],
162+
Guides: [
163+
"guides/context_abi.md",
164+
"guides/generalized_stack.md",
165+
"guides/qc_and_operations.md",
166+
"guides/code_smell_remediation.md"
167+
],
160168
Project: ["CHANGELOG.md", "LICENSE"]
161169
]
162170
]

0 commit comments

Comments
 (0)