Skip to content

docs(design): detail module contracts and sync interface map - #104

Merged
bouillipx merged 1 commit into
mainfrom
v1_todo
Feb 26, 2026
Merged

docs(design): detail module contracts and sync interface map#104
bouillipx merged 1 commit into
mainfrom
v1_todo

Conversation

@bouillipx

Copy link
Copy Markdown
Collaborator

Expand module design docs to a consistent detailed structure aligned with agent detailed docs and current implementation contracts.

Key changes:

  • Reworked module READMEs to explicitly include public interfaces, core fields, and runtime flows.
  • Added transport module main design entrypoint at docs/design/modules/transport/README.md.
  • Appended explicit contract/field/flow snapshots to long-form context, hook, tool, and agent docs.
  • Updated docs/design/modules/README.md index to reflect the new transport entrypoint and detail standard.
  • Rewrote docs/design/Interfaces.md as a synced cross-module contract table derived from current kernel/interfaces/types.

Rationale:

  • Reduce ambiguity between design docs and code signatures.
  • Make cross-module integration points auditable and easier to review.
  • Provide a single authoritative interface map for future implementation and refactor work.

Summary

  • What does this PR change?
  • Why is this change needed?

Scope (One PR One Thing)

  • Primary objective:
  • Out of scope:
  • I confirm this PR handles a single objective only: [ ] Yes

Changed Files (required)

List all touched files and why each file changed.

File Reason
path/to/file reason

If this PR is a large diff (>300 changed lines), explain why split PRs are not possible and provide a split follow-up plan.

Acceptance Criteria

  • Criteria 1
  • Criteria 2

Test Evidence (required)

  • Local commands run:
    • ...
  • CI links or job names:
    • ...
  • Evidence/output summary:
    • ...

If this PR changes high-risk runtime paths (auth/concurrency/execution control), include risk-matrix evidence.

Risk and Rollback

  • Risk level: Low / Medium / High
  • Main risk points:
  • Rollback plan:

Dependency and Lockfile Changes

  • Lockfile changed in this PR: [ ] Yes [ ] No
  • If yes, manifest updated in same PR (requirements.txt/pyproject.toml/package.json): [ ] Yes [ ] No [ ] N/A

Agent Rules Checklist (required)

Reference: docs/agent_rules.md

  • Only task-related files changed; no opportunistic refactor
  • Public interfaces/data structures unchanged unless explicitly required
  • Tests added/updated and evidence attached
  • Any skip/only/exclude usage is explained and reviewed
  • Merge will be done by approved reviewer (no self-merge auto-ship)

Expand module design docs to a consistent detailed structure aligned with agent detailed docs and current implementation contracts.

Key changes:
- Reworked module READMEs to explicitly include public interfaces, core fields, and runtime flows.
- Added transport module main design entrypoint at docs/design/modules/transport/README.md.
- Appended explicit contract/field/flow snapshots to long-form context, hook, tool, and agent docs.
- Updated docs/design/modules/README.md index to reflect the new transport entrypoint and detail standard.
- Rewrote docs/design/Interfaces.md as a synced cross-module contract table derived from current kernel/interfaces/types.

Rationale:
- Reduce ambiguity between design docs and code signatures.
- Make cross-module integration points auditable and easier to review.
- Provide a single authoritative interface map for future implementation and refactor work.
@bouillipx
bouillipx merged commit afe6451 into main Feb 26, 2026
6 checks passed
@bouillipx
bouillipx deleted the v1_todo branch February 26, 2026 09:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant