Skip to content

docs: add live architecture map and update policy - #25

Merged
samzong merged 1 commit into
mainfrom
docs/live-architecture-map
Aug 6, 2026
Merged

docs: add live architecture map and update policy#25
samzong merged 1 commit into
mainfrom
docs/live-architecture-map

Conversation

@samzong

@samzong samzong commented Aug 6, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Add docs/architecture.mmd as the canonical ownership-boundary map for kitup (SDK workflow, contracts, verification, host state).
  • Document in AGENTS.md when the map must be updated versus when internal refactors should leave it alone.

Scope Check

  • Stays within the v0.1 bundled-skill installer boundary.
  • Does not add marketplace, registry, remote install, script execution, GUI, MCP server, or agent runtime behavior.
  • Updates golden cases for observable installer behavior changes. (N/A — docs only)
  • Regenerates host constants after spec/hosts.json changes. (N/A — no host spec change)

Verification

  • make check

Considered and deferred

  • AGENTS.md:Multi-Language Parity [BOT-SCOPE]: Pre-existing section still says TypeScript/Go/Rust only while docs/architecture.mmd and scripts/sync-hosts.mjs include python; out of this map-policy change scope.
  • docs/architecture.mmd:6 [BOT-TASTE]: Workflow node labels Go-style RunBundledSkillInstall only; TS/Python use camel/snake variants — acceptable for ownership map, not API catalog.

## Considered and deferred

- AGENTS.md:Multi-Language Parity [BOT-SCOPE]: Pre-existing section still says TypeScript/Go/Rust only while docs/architecture.mmd and scripts/sync-hosts.mjs include python; out of this map-policy change scope.
- docs/architecture.mmd:6 [BOT-TASTE]: Workflow node labels Go-style RunBundledSkillInstall only; TS/Python use camel/snake variants — acceptable for ownership map, not API catalog.

Signed-off-by: samzong <samzong.lu@gmail.com>

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: a79407122a

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/architecture.mmd
Comment thread docs/architecture.mmd
@samzong
samzong merged commit 9f374d8 into main Aug 6, 2026
22 checks passed
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