Skip to content

feat: SIMOVI agent reference layer#6

Open
dotjae wants to merge 18 commits into
mainfrom
feat/agent-reference-restructure
Open

feat: SIMOVI agent reference layer#6
dotjae wants to merge 18 commits into
mainfrom
feat/agent-reference-restructure

Conversation

@dotjae
Copy link
Copy Markdown
Contributor

@dotjae dotjae commented May 18, 2026

Summary

Transforms context/ from a thin documentation collection into the canonical, cross-tool, org-wide reference layer for any AI agent (Copilot, Warp, Claude Code, Cursor, etc.) working on SIMOVI systems.

What changed

  • AGENTS.md (new) — universal entry point; any agent in any tool reads this first.
  • README.md (rewritten) — human entry point with quick-start per tool.
  • reference/ (new directory):
    • systems/databus.md — canonical Databús overview (role, monorepo structure, compose services, key models, telemetry→GTFS-RT flow, run lifecycle, FSM cross-links). Last verified 2026-05-17.
    • systems/infobus.md — canonical Infobús overview sourced from current repo state (FastMCP context/, Jena Fuseki knowledge/, Nuxt frontend, WebSocket/SSE display pipeline). Last verified 2026-05-17.
    • domain/naming.md — naming-convention table (services, processes, states, events, actions, messages).
    • domain/gtfs.md — GTFS Schedule file/field reference, GTFS-RT protobuf structure, common mistakes.
    • domain/transit-concepts.md — glossary: run, trip, route, stop, vehicle, telemetry, dispatcher, operator, lifecycle.
    • principles/ — 8 existing top-level docs moved here with kebab-case renames (system_design_principles.mdsystem-design.md, etc.).
  • skills/ (new directory) — vendored Claude Code skills: databus, infobus (trimmed, pointer to reference/), gtfs (trimmed), fsm2ref, src2fsm (verbatim workflow skills). Install instructions in skills/README.md.
  • templates/ (new directory) — generic AGENTS.md starter, .mcp.json skeleton, proposed slim replacements for databus/AGENTS.md (~133 lines, down from ~275) and infobus/AGENTS.md (~135 lines, reality-checked against current repo).

This branch also carries the earlier docs/processes commits (run-lifecycle FSM + process specs) which were in-flight on the base branch. Those are docs-only and land naturally here.

Migration note

The following paths changed and any external links to the old locations will break:

Old path New path
architecture.md reference/principles/architecture.md
system_design_principles.md reference/principles/system-design.md
data_principles.md reference/principles/data.md
methods.md reference/principles/methods.md
tech_stack.md reference/principles/tech-stack.md
roadmap.md reference/principles/roadmap.md
software.md reference/principles/software.md
trl.md reference/principles/trl.md

Test plan

  • AGENTS.md links all resolve (reference/, skills/, templates/, behavior/).
  • No > **Stub.** markers anywhere in the repo.
  • reference/systems/*.md both carry "Last verified: 2026-05-17".
  • templates/infobus-AGENTS.md does NOT mention django-app-gtfs as a submodule.
  • skills/README.md install instructions are runnable.

Kroenenn and others added 18 commits April 8, 2026 22:51
Signed-off-by: Kroenenn <gabrielps200325@gmail.com>
Signed-off-by: Kroenenn <gabrielps200325@gmail.com>
…ted respective processes references (/docs) and made sure they match with the references.
Signed-off-by: Kroenenn <gabrielps200325@gmail.com>
- Create reference/, skills/, templates/ directory trees
- Stub every file with one-liner description and target PR
- Move 8 top-level docs into reference/principles/ with kebab-case renames
- Write functional root AGENTS.md (cross-tool universal entry point)
- Rewrite README.md as human entry point
feat: scaffold agent reference layer
feat: templates + downstream AGENTS.md proposals
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.

2 participants