docs: add source evidence and coding-obligation predicates to uring agent guides#24
Merged
Merged
Conversation
Signed-off-by: Robin He <git@hybscloud.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Pull request overview
This PR updates the uring agent guides (documentation/formalization) to make runtime integration rules more review-checkable by explicitly listing “source evidence” inputs and adding CodingObligation_* predicates for the caller-layer runtime packages (kont, cove, takt, sess), plus related lift/formalization refinements.
Changes:
- Add
Source_*evidence sets andCodingObligation_*predicates to the runtime guides (agents/runtime/*). - Add path/source-reading notation (
Path,SourceFile,read_current_source) and propagate source-check obligations into the runtime lift (agents/lift/protocols-runtime.md). - Minor formalization cleanup/strengthening (e.g., strata order consistency, quantified protocol-step constraint, and more explicit compilation predicates).
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| AGENTS.md | Notes that runtime guides now include source-evidence and coding-obligation material for review. |
| agents/runtime/INDEX.md | Updates runtime-guide index text to mention CodingObligation_* predicates and source evidence. |
| agents/runtime/kont.md | Adds Source_kont and CodingObligation_kont predicate. |
| agents/runtime/cove.md | Adds Source_cove and CodingObligation_cove predicate. |
| agents/runtime/takt.md | Adds Source_takt, completion-value copying predicate, and CodingObligation_takt. |
| agents/runtime/sess.md | Adds Source_sess, clarifies transport domain, and adds CodingObligation_sess. |
| agents/lift/protocols-runtime.md | Extends runtime lift with RuntimeSource_rc, context/copy helpers, and CodingObligation_*_rc predicates. |
| agents/formalization/notation.md | Defines B earlier, adds K, and introduces Path/SourceFile/read_current_source. |
| agents/formalization/sessions.md | Minor strata ordering consistency (B = boundary(module) moved earlier). |
| agents/formalization/INDEX.md | Replaces large vocabulary code block with a navigation-oriented bullet list. |
| agents/formalization/go-mapping.md | Makes compilation obligations more explicit via existentials and action-specific compilation constraints. |
Comment on lines
+56
to
+62
| Source_takt = | ||
| {path("takt/backend.go"), path("takt/takt.go"), path("takt/bridge.go"), | ||
| path("takt/step.go"), path("takt/error.go"), path("takt/loop.go"), | ||
| path("takt/option.go"), path("takt/subscription_backend.go"), | ||
| path("takt/subscription.go"), path("takt/subscription_option.go"), | ||
| path("takt/completion_memory.go")} | ||
| source_checked(Source_takt) ⇔ ∀ f ∈ Source_takt. read_current_source(f) |
Comment on lines
+54
to
+59
| Source_sess = | ||
| {path("sess/op.go"), path("sess/session.go"), path("sess/step.go"), | ||
| path("sess/error.go"), path("sess/run.go"), path("sess/bridge.go"), | ||
| path("sess/fused.go"), path("sess/fused_expr.go"), | ||
| path("sess/rec.go"), path("sess/exec.go"), path("sess/serial.go")} | ||
| source_checked(Source_sess) ⇔ ∀ f ∈ Source_sess. read_current_source(f) |
Comment on lines
+50
to
+55
| Source_kont = | ||
| {path("kont/effect.go"), path("kont/cont.go"), path("kont/frame.go"), | ||
| path("kont/bridge.go"), path("kont/step.go"), path("kont/trampoline.go"), | ||
| path("kont/index.go"), path("kont/affine.go"), path("kont/marker_pool.go"), | ||
| path("kont/pool.go"), path("kont/dispatch.go")} | ||
| source_checked(Source_kont) ⇔ ∀ f ∈ Source_kont. read_current_source(f) |
Comment on lines
+55
to
+61
| Source_cove = | ||
| {path("cove/constraint.go"), path("cove/view.go"), path("cove/cmd.go"), | ||
| path("cove/req.go"), path("cove/req_expr.go"), path("cove/rule.go"), | ||
| path("cove/rule_expr.go"), path("cove/checked.go"), | ||
| path("cove/checked_expr.go"), path("cove/step.go"), | ||
| path("cove/kripke.go"), path("cove/bridge.go")} | ||
| source_checked(Source_cove) ⇔ ∀ f ∈ Source_cove. read_current_source(f) |
Comment on lines
+314
to
+333
| RuntimeSource_rc = | ||
| { path("kont/effect.go"), path("kont/cont.go"), path("kont/frame.go"), | ||
| path("kont/bridge.go"), path("kont/step.go"), path("kont/trampoline.go"), | ||
| path("kont/index.go"), path("kont/affine.go"), path("kont/marker_pool.go"), | ||
| path("kont/pool.go"), path("kont/dispatch.go"), | ||
| path("cove/constraint.go"), path("cove/view.go"), path("cove/cmd.go"), | ||
| path("cove/req.go"), path("cove/req_expr.go"), path("cove/rule.go"), | ||
| path("cove/rule_expr.go"), path("cove/checked.go"), | ||
| path("cove/checked_expr.go"), path("cove/step.go"), | ||
| path("cove/kripke.go"), path("cove/bridge.go"), | ||
| path("takt/backend.go"), path("takt/takt.go"), path("takt/bridge.go"), | ||
| path("takt/step.go"), path("takt/error.go"), path("takt/loop.go"), | ||
| path("takt/option.go"), path("takt/subscription_backend.go"), | ||
| path("takt/subscription.go"), path("takt/subscription_option.go"), | ||
| path("takt/completion_memory.go"), | ||
| path("sess/op.go"), path("sess/session.go"), path("sess/step.go"), | ||
| path("sess/error.go"), path("sess/run.go"), path("sess/bridge.go"), | ||
| path("sess/fused.go"), path("sess/fused_expr.go"), | ||
| path("sess/rec.go"), path("sess/exec.go"), path("sess/serial.go") } | ||
| source_checked(RuntimeSource_rc) ⇔ ∀ f ∈ RuntimeSource_rc. read_current_source(f) |
Comment on lines
+257
to
+263
| PathName = {p | finite_string(p)} | ||
| Path = {path(p) | p ∈ PathName} | ||
| SourceFile = {f ∈ Path | checked_out_source_file(f)} | ||
| read_current_source : SourceFile → Bool | ||
| read_current_source(f) ⇔ | ||
| f ∈ SourceFile ∧ file_exists(f) ∧ read_at_current_revision(f) | ||
|
|
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
Adds review-checkable evidence to the
uringpackage agent guides: each caller-layer runtime guide now names the package source files it relies on and states a coding obligation, so a reviewer can confirm the guide still matches the current public package surface. The change is documentation-only and does not touch product code.