Repository navigation
docs: refresh core and KDN module maps - #155
Conversation
There was a problem hiding this comment.
💡 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".
|
|
||
| `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). |
There was a problem hiding this comment.
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 👍 / 👎.
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
core/README.md:__init__.pyandruntime_compat.pyto the module map;core.runtime_compatimport boundary and the dependency-lightcacheroute_compatimplementation;kdn_server/README.md:domain/,contracts/,gateway/, andutil/;Scope
Documentation only.
README.mdis unchanged.Validation
mainis limited tocore/README.mdandkdn_server/README.md.docs/,kdn_server/, andtest/kdn/.Related to #140 and prepares documentation navigation for research on #141.