Repository navigation
docs: introduce LingTai ANATOMY+CONTRACT navigation and interface system - #224
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Introduces the LingTai kernel's distributed code navigation (ANATOMY) and interface definition (CONTRACT) system into this repo, adapted to its size.
The repo already had three hand-written
ANATOMY.mdfiles in an ad-hoc shape. This PR rewrites them to the canonical LingTai convention and completes the paired system: a root contract-of-contract, three governed component contracts, and a mechanical drift checker + architecture-document validation suite.What changed
ANATOMY.md— rewritten with YAML frontmatter (related_files+maintenance), navigation model, five-section body, link/pairing semantics, and verifiedfile:linecitations throughout.CONTRACT.md(NEW) — the contract-of-contract: design principles (artifact-first responses,source_typedispatch, backend port isolation, packaged-skills-as-capability, thin wrappers), Core/Ports/Adapters architecture foundation, governed-component list, child template + pairing/ownership/versioning rules.src/spedas_agent_kit/ANATOMY.md— rewritten to convention; stale workflow citations corrected (search_data_sources816→824,compare_sources848→856,plan_observation870→1170,create_analysis_bundle1016→1351) and previously-uncited anchors added (_normalize_source_typeserver.py:1852,_wrap_data_payload:1927,serve():2796, etc.).src/spedas_agent_kit/CONTRACT.md(NEW) — the package facade contract: the 13 base + 8 compat MCP tool surface, artifact-first{status, file_path, stats}response shape, structured-error contract,source_typedispatch, lazy backend imports.src/spedas_agent_kit/backends/—ANATOMY.mdrewritten;CONTRACT.md(NEW) defines the vendored CDAWeb/PDS/SPICE data-backend Port contract.src/spedas_agent_kit/resources/—ANATOMY.md+CONTRACT.md(NEW) for the packaged-skills capability: skill catalog, event presets, provenance, schemas, index rendering.scripts/check_anatomy_drift.py(NEW) — adapted from the LingTai kernel drift checker: stdlib-only citation-rot scanner over everyANATOMY.md; report mode +--checkgate for CI.tests/test_architecture_documents.py(NEW) — validates frontmatter, repo-relative dup-freerelated_files, reciprocal ANATOMY/CONTRACT pairing, root CONTRACT listing each governed child exactly once, childroot_contract+ paired anatomy, and no empty stub sections. Minimal frontmatter parser — no PyYAML dependency.Validation
tests/test_architecture_documents.py: 11 passed.scripts/check_anatomy_drift.py --check: zero drift across 4 ANATOMY files.test_server/test_resources/test_config: untouched by this doc-only change (pre-existingspiceypyenv gap unrelated to this PR).Notes