docs: qualify package identity across uring agent guides - #23
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-guide documentation to consistently refer to neighbor packages by their fully-qualified import identity (code.hybscloud.com/{pkg}), aiming to keep prose, owner maps, and formal/lift terminology aligned across the guide set.
Changes:
- Qualify neighbor package references throughout the workflow, boundary, runtime, formalization, and lift docs (e.g.,
iox→code.hybscloud.com/iox). - Strengthen guide-edit workflow instructions to require reading the complete current source of all relied-on neighbor packages before broad/cross-package-model edits.
- Extend the
taktruntime guide and the runtime-carriers lift with additional formal-model detail (not just naming/qualification).
Reviewed changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| agents/workflow/task-checklists.md | Qualifies runtime-package names and strengthens “broad edit” prereqs to include reading neighbor package sources. |
| agents/workflow/boundary-gates.md | Updates G_read gate wording to require reading code.hybscloud.com/iox explicitly. |
| agents/runtime/takt.md | Qualifies package mentions and adds/adjusts formal model details around completion-memory storage and fatal/drain behavior. |
| agents/runtime/sess.md | Qualifies neighbor package references (iox, takt, etc.) and clarifies outcome-plane asymmetry phrasing. |
| agents/runtime/kont.md | Qualifies kont/takt references in rules text. |
| agents/runtime/cove.md | Qualifies cove references in rules text. |
| agents/lift/protocols-runtime.md | Qualifies runtime package references and refines runtime owner/fatal/drain/token-reuse modeling in the lift. |
| agents/lift/INDEX.md | Qualifies runtime carrier references in the lift index prose. |
| agents/formalization/sessions.md | Qualifies uring references in introductory prose. |
| agents/formalization/resources.md | Qualifies uring references in introductory prose. |
| agents/formalization/notation.md | Qualifies uring references in introductory prose. |
| agents/formalization/kernel-boundary.md | Qualifies uring references and cove mention in explanatory prose. |
| agents/formalization/INDEX.md | Qualifies terminology and updates how the composed-guide check is described; adjusts vocabulary listing. |
| agents/formalization/handler.md | Qualifies uring references in prose. |
| agents/formalization/guarantees.md | Qualifies uring references in prose. |
| agents/formalization/go-mapping.md | Qualifies uring references in prose. |
| agents/boundary/resources.md | Qualifies iobuf ownership references. |
| agents/boundary/protocols.md | Qualifies neighbor package ownership references in rule list. |
| agents/boundary/integration.md | Qualifies neighbor package ownership references and cove carrier wording. |
| AGENTS.md | Adds explicit instruction to read full neighbor package sources for broad/cross-package-model guide edits. |
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
Make the uring agent guides refer to every neighbour package by its fully-qualified
code.hybscloud.com/{pkg}import identity instead of a bare short name, and carry that identity into the runtime carrier lifts so prose, owner maps, and formal terms agree.Changes
iox,iofd,sock,iobuf,kont,cove,takt,sess,zcall,spin,lfq,framer) withcode.hybscloud.com/{pkg}in owner maps, boundary rules, and guide prose.