docs: add agentic coding guide for uring usage#22
Merged
Conversation
Signed-off-by: Robin He <git@hybscloud.com>
Signed-off-by: Robin He <git@hybscloud.com>
There was a problem hiding this comment.
Pull request overview
This PR introduces an “agentic coding” documentation set for caller-side systems built above or beyond code.hybscloud.com/uring, clarifying the boundary between kernel-facing mechanics (owned by uring) and caller-owned policy/runtime concerns.
Changes:
- Adds a new guide entrypoint (
AGENTS.md) and a comprehensiveagents/documentation tree (workflow, boundary, formalization, runtime utilization, lift records, and references). - Updates all localized READMEs to (a) reflect the refined boundary responsibilities (routing/route retirement/safety checks) and (b) add a section pointing to the new guide set.
- Reformats
CQEView’s “Property Patterns” documentation to a prose list for clearer Godoc rendering.
Reviewed changes
Copilot reviewed 40 out of 40 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates boundary language and adds an “Agentic coding” section pointing readers to the new guide set. |
| README.zh-CN.md | Same as README.md, for Simplified Chinese; also adjusts boundary phrasing and ZCTracker description. |
| README.ja.md | Same as README.md, for Japanese; also adjusts boundary phrasing and line-wrapped explanation. |
| README.fr.md | Same as README.md, for French; also adjusts boundary phrasing and related sections. |
| README.es.md | Same as README.md, for Spanish; also adjusts boundary phrasing and related sections. |
| cqe_view.go | Replaces a markdown table in Godoc with a structured bullet list describing Direct/Indirect/Extended modes. |
| AGENTS.md | Adds the package-local entrypoint describing purpose, required reading, boundary placement, and workflow for caller-side code. |
| agents/INDEX.md | Adds the top-level index and reading order for the entire guide set. |
| agents/references.md | Adds a primary-source research checklist and a curated source priority list for external claims. |
| agents/workflow/INDEX.md | Adds a workflow index and recommended reading order for workflow documents. |
| agents/workflow/boundary-gates.md | Defines pass/fail gates for boundary correctness (placement, outcome separation, hot-path cleanliness, etc.). |
| agents/workflow/task-checklists.md | Adds task-shape → required-reading mapping and preflight checklist requirements. |
| agents/workflow/proof-obligations.md | Adds a named proof-obligations checklist aligning with the workflow gates and formal model. |
| agents/workflow/task-loop.md | Adds the staged “task loop” for design vs review and defines stage invariants and verification expectations. |
| agents/boundary/INDEX.md | Adds boundary topic index for SQE/CQE, resources, integration, and protocols. |
| agents/boundary/integration.md | Documents package-owner boundaries and what may/must not cross into code.hybscloud.com/uring. |
| agents/boundary/protocols.md | Defines caller-side protocol/runtime rules and “shallow handler” discipline above the boundary. |
| agents/boundary/sqe-cqe.md | Specifies SQE/CQE encoding/observation/decode rules, including hot-path constraints and borrow/copy rules. |
| agents/runtime/INDEX.md | Adds runtime utilization index and reading order for kont, cove, takt, sess. |
| agents/runtime/kont.md | Documents correct one-shot suspension/resumption integration rules for kont with uring. |
| agents/runtime/cove.md | Documents context/requirement evidence carrying and re-checking rules for cove across suspension boundaries. |
| agents/runtime/takt.md | Documents runner/loop/token/route semantics for takt usage with uring (one-shot vs multishot). |
| agents/runtime/sess.md | Documents session protocol stepping rules for sess on top of boundary observations. |
| agents/lift/INDEX.md | Adds index for saved lift records and guidance for where/how to save lift checkpoints. |
| agents/lift/policy-separation.md | Adds a saved lift record capturing the caller-policy vs boundary-mechanics separation. |
| agents/formalization/INDEX.md | Adds the formalization reading order and vocabulary preservation requirements. |
| agents/formalization/overview.md | Defines the core judgment shape, the three separations, concept routing/ownership, and WF/composability. |
| agents/formalization/kernel-boundary.md | Formalizes strata ownership and SQE↔CQE correspondence constraints. |
| agents/formalization/outcomes.md | Formalizes outcome vs release planes and q_iox control classification constraints. |
| agents/formalization/resources.md | Formalizes resource kinds, ownership epochs, and release/retain constraints. |
| agents/formalization/sessions.md | Formalizes session/protocol frontier stepping and required asymmetries. |
| agents/formalization/handler.md | Formalizes shallow-handler semantics, normalization, and suspend/resume boundary constraints. |
| agents/formalization/go-mapping.md | Formalizes lift/compile roundtrips and BoundaryClean constraints for Go surfaces. |
| agents/formalization/verification.md | Defines verification evidence requirements and Verify(J, go_surface) predicate closure. |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Signed-off-by: Robin He <git@hybscloud.com>
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.
Summary
This PR adds a guide set for code built above or beyond
uring.The guide clarifies the package boundary:
uringowns ring setup, SQE encoding, CQE observation, completion identity, ownership, capability, and lifecycle facts. Layers above or beyonduringown retry, scheduling, routing, poll cadence, completion routing, route retirement, protocol state, parsing, safety checks, and service policy.Changes
AGENTS.mdas the package-local guide entrypoint for code built above or beyonduring.agents/topic tree:boundary/for SQE/CQE, resources, protocols, and integration;formalization/for notation, outcomes, resources, sessions, handlers, mapping, guarantees, and verification;lift/for saved boundary and policy records;runtime/forkont,cove,takt, andsess;workflow/for boundary gates, proof obligations, task checklists, and task loops; plusreferences.md.