Skip to content

Add Core deep dives and adapter boundaries - #8

Merged
sparkplug604 merged 1 commit into
mainfrom
codex/core-docs-adapter-boundaries
Jun 13, 2026
Merged

Add Core deep dives and adapter boundaries#8
sparkplug604 merged 1 commit into
mainfrom
codex/core-docs-adapter-boundaries

Conversation

@sparkplug604

Copy link
Copy Markdown
Owner

Summary

  • Add Core deep-dive docs for architecture, ingestion, retrieval, entity-aware evidence, maintenance/hygiene, conflicts/dedupe, and how Praxis Core differs from typical RAG.
  • Clarify adapters/ as an optional runtime/framework bridge surface, separate from Reach data connectors and Core intake helpers.
  • Link the new Core deep dives from the docs index, Core module README, and Core path page so readers can find the ingestion/retrieval/entity-evidence story without hunting.

Why

A reader trying to understand entity-aware evidence, ingestion, retrieval, maintenance, and conflict management could not find those mechanics clearly in the READMEs. This PR makes those Core concepts discoverable while keeping the root README lightweight.

Positioning Notes

  • Describes current entity support as entity-aware evidence annotations, not a literal entity_cards table.
  • Notes that compare_entities is not currently exposed as a public command.
  • Frames adapters as planned/optional integration boundaries rather than required runtime packages.

Validation

  • python3 /Users/larissawcox/.codex/skills/usability-mapping/scripts/markdown_usability_audit.py docs/modules/core -> friction score 0.
  • python3 /Users/larissawcox/.codex/skills/usability-mapping/scripts/markdown_usability_audit.py adapters/README.md -> friction score 0.
  • Relative Markdown link check across README.md, docs/, and adapters/ -> no broken relative links.
  • git diff --check -> passed.
  • Full repo Markdown scan remains at friction score 27, with remaining backlog in pre-existing connector docs, root README density, sub-adapter stubs, bootstrap, examples, and Reach docs.

@vercel

vercel Bot commented Jun 13, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
praxis Error Error Jun 13, 2026 10:59pm

@sparkplug604 sparkplug604 changed the title [codex] Add Core deep dives and adapter boundaries Add Core deep dives and adapter boundaries Jun 13, 2026
@sparkplug604
sparkplug604 marked this pull request as ready for review June 13, 2026 23:00
@sparkplug604
sparkplug604 merged commit 54930ef into main Jun 13, 2026
3 of 4 checks passed
@sparkplug604
sparkplug604 deleted the codex/core-docs-adapter-boundaries branch June 13, 2026 23:01
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