Repository navigation
docs: reconcile transitional paths with RFC package guidance - #161
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 1e2f8079f9
ℹ️ 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".
| | Current path | Current role | Target owner/package | Migration phase | Interim rule | | ||
| |---|---|---|---|---| | ||
| | `core` | Shared request, configuration, forwarding, tokenizer, model-calculation, and runtime-compatibility code | Split by proven semantics among `cacheroute.contracts`, `cacheroute.runtime`, relevant domains, and temporary `cacheroute.compat`; exact file ownership requires a focused audit | Phase 2, with compatibility cleanup in Phase 6 | Keep compatibility fixes in `core`; do not reproduce it as `cacheroute.core`. | |
There was a problem hiding this comment.
Account for omitted installed packages
Complete this supposedly tree-audited mapping with dispositions for data and doc: pyproject.toml lines 49–51 currently install data, data.CacheRoute_dataset, doc, and related namespaces, and the Phase A inventory also records them, but neither appears in this table. A later migration using this authoritative map therefore has no owner or phase for removing these top-level wheel packages—and may either leave them in the final wheel or drop runtime data without the required package-data audit.
AGENTS.md reference: AGENTS.md:L600-L611
Useful? React with 👍 / 👎.
Motivation
AGENTS.mdnormative but left Sections 1–17 with unqualified current-root path examples that contributors could misinterpret as permanent package-placement guidance.cacheroute.*RFC so contributors follow a single authoritative source without beginning any code migration.Description
AGENTS.md: updatedversion-dateto26-07-30, labeledscheduler/,proxy/,instance/, andkdn_server/root packages and strategy modules as transitional compatibility locations, corrected stale path examples (e.g.kdn/...→kdn_server/...,client.py/perf_client.py→client/client.py/client/perf_client.py, demo names →test/demo_*.py), and added the decision rule for fixes vs new cross-component work vs migrations.doc/architecture/package-architecture-rfc.md: added a status header linkingIssue #159,Issue #157,PR #158, andPR #160and noting coordination withIssue #141, clarified ownership semantics (contracts, domain ports, integrations, services, entrypoints, plugins, observability, UI assets,crates/), added an audited “Current layout versus target ownership” mapping forcore,scheduler,proxy,instance,kdn_server,client,store,model,util,UI,test,scripts,env, andlog, and added anArchitecture decision checklistwith the full operational-path audit scope.doc/architecture/README.md: expanded the index to reference the RFC, the migration Epic, the Phase A audit, and the root README's role.cacheroute.coreor speculative packages were created.AGENTS.md,doc/architecture/README.md,doc/architecture/package-architecture-rfc.md.Issue #159,Issue #157,Issue #141.Testing
git diff --checkwhich passed.architecture documentation reconciliation: PASS).python3 -m pytest -q test/test_repository_governance.pywhich returned 6 passed, 1 failed with the failure due to the existing root-discovery check treating the presentdoc/architecturedirectory as an unconfigured namespace (doc.architecture), not caused by runtime or packaging changes in this PR.python3 -m pytest -q test/test_namespace_layout.pywhich returned 4 passed, 1 failed with the failure due to the isolated test process lacking a runtime dependency (numpy) when importingclient.client, and not caused by this documentation-only change.git diff --name-onlyincludes exactly the three documentation files changed andgit diff --numstat -- AGENTS.mdis35 13 AGENTS.md, confirming a scoped edit rather than a whole-file rewrite;README.mdand runtime code are unchanged.Refs #159
Refs #157
Refs #141
Codex Task