Skip to content

docs: refresh core and KDN module maps - #155

Merged
rickisba merged 2 commits into
mainfrom
docs/refresh-v0110-module-readmes
Jul 29, 2026
Merged

rickisba merged 2 commits into
mainfrom
docs/refresh-v0110-module-readmes

Conversation

@rickisba

Copy link
Copy Markdown
Collaborator

Purpose

Post-merge documentation cleanup after PR #154 / Issue #140. This keeps the repository homepage unchanged while making the module-level READMEs reflect the v0.1.10 runtime, domain-contract, and Gateway structure now present on main.

Changes

  • Update core/README.md:
    • add __init__.py and runtime_compat.py to the module map;
    • explain the stable core.runtime_compat import boundary and the dependency-light cacheroute_compat implementation;
    • link to the KDN Runtime Profile vocabulary and the existing v1 runtime compatibility guide.
  • Update kdn_server/README.md:
    • preserve all existing operational KDN documentation;
    • expand only the directory map to include domain/, contracts/, gateway/, and util/;
    • link the new packages to their detailed nested READMEs and CPU-only workflow documentation.

Scope

Documentation only.

  • Root README.md is unchanged.
  • No source code, contract, validation rule, wire value, Gateway behavior, test, or runtime configuration is modified.
  • Existing KDN HTTP, CLI, KV construction, injection, screenshots, examples, and Legacy documentation remain in place.

Validation

Related to #140 and prepares documentation navigation for research on #141.

@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: 1564b55752

ℹ️ 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 core/README.md

`core/runtime_compat.py` is the compatibility-facing import path used by existing CacheRoute modules. The dependency-light implementation lives in `cacheroute_compat/runtime.py`, which keeps Runtime Profile normalization available without importing the full application graph.

Persisted and wire-level objects must use a resolved Runtime Profile (`legacy`, `v1`, or `test/mock`). The `auto` value is limited to startup resolution and must not become an operation-time fallback. The storage-neutral KDN representation of these profiles is documented in the [KDN domain vocabulary](../kdn_server/domain/README.md); serving-stack migration and startup details remain in [runtime compatibility documentation](../docs/runtime_compatibility_v1.md).

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Point the runtime guide link at doc/

The newly added link resolves to docs/runtime_compatibility_v1.md, which does not exist, so readers following the migration/startup documentation receive a 404. A repo-wide path search at this commit finds the guide at doc/runtime_compatibility_v1.md; update the relative target to ../doc/runtime_compatibility_v1.md.

AGENTS.md reference: AGENTS.md:L273-L277

Useful? React with 👍 / 👎.

@rickisba
rickisba merged commit ad087d1 into main Jul 29, 2026
@rickisba
rickisba deleted the docs/refresh-v0110-module-readmes branch July 29, 2026 07:26
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