Skip to content

The README links what runs and says where the engine stands - #95

Merged
robertblust merged 2 commits into
mainfrom
the-readme-draws-what-runs
Oct 4, 2026
Merged

robertblust merged 2 commits into
mainfrom
the-readme-draws-what-runs

Conversation

@robertblust

@robertblust robertblust commented Oct 4, 2026 •

Copy link
Copy Markdown
Contributor

The README's diagram drew a timeline service beside the engine, generic connectors in "this org", no service-conventions and no schema split, and its status said "Early development" while the organization profile marks every phase done. The organization's AGENTS.md also says which services run and what they talk to is owned by the profile alone, and that a component diagram copied into a README is drift.

So the diagram is gone rather than corrected: How it fits together keeps what is the engine's own, that it serves the API every other component is a client of and holds the timeline, and links the profile's What runs, which guestgraph/.github #40 brings up to date. The status now says the engine is built spec-first one slice at a time, with the specifications in specs/, the design in docs/ and .specify/, the slices done and next on the organization page, and what a slice left for later in docs/roadmap-notes.md.

Verified: conventions-check and conventions-format pass on the branch.

🤖 Generated with Claude Code

robertblust and others added 2 commits October 4, 2026 18:58
The architecture diagram still showed the timeline as a component of its own and the connectors as a generic box, while the timeline is a package inside the engine and the first connector is its own repository. It also left out service-conventions and the schema each service owns, and the status line called the project early development while the organization page marks every phase done.

The diagram now shows connector-apaleo calling the engine's REST API with an X-API-Key header, each service on its own PostgreSQL schema as their application.yaml files name it, and both taking service-conventions at the release they vendor. The status says how the work is built and points to the organization page for what is done and what comes next, so it does not go stale as slices land.

Verified: the diagram renders with mmdc, and sh conventions/conventions-check, sh conventions/conventions-format and sh conventions/conventions-sync check passed.

Process: Delivery
Phase: Implement
Track: Prose
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
AGENTS.md of the organization's profile repository says which services run and what they talk to is owned by the profile alone, and that a component diagram copied into a repository README is drift. The corrected diagram is therefore taken out again: the section keeps what is the engine's own, that it serves the API every other component is a client of and holds the timeline, and links the profile's What runs for the rest.

Verified: conventions-check and conventions-format pass.

Process: Delivery
Phase: Implement
Track: Prose
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@robertblust robertblust changed the title The README draws the services that run today The README links what runs and says where the engine stands Oct 4, 2026
@robertblust
robertblust merged commit 52f46dc into main Oct 4, 2026
4 checks passed
@robertblust
robertblust deleted the the-readme-draws-what-runs branch October 4, 2026 17:15
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