Files
central_ai_llm_master/docs/outline/03-code-map.md

1.8 KiB

Central AI Hub — Code Structure Map

Writing Style: ASD-STE100 Simplified Technical English (ste-writing). Status: Planned. The Hub is not built yet.

Planned Folder Layout

central_ai_llm_master/
  AGENTS.md                 project rules for agents
  hub_brief.md              agreed design (source of truth)
  README.md                 technical readme
  docs/
    hub-architecture.mmd    Mermaid source
    hub-architecture-map.html  Archify map
    diagrams/               rendered images
    archify/                Archify JSON input
    outline/                AI context documents
    vikunja-tasks.json      human task list
  src/                      Hub service code (to build)
    main.*                  HTTP entry point
    hear/                   takes voice or text
    understand/             LLM intent routing
    check/                  authorization and approval
    route/                  dispatch to a destination
    answer/                 reply shaping (text, TTS, notify)
    destinations/           one client per destination
  tests/                    unit and round-trip tests

Entry Points

Entry point Use
POST /ask Send a voice transcript or text. Returns a reply.
POST /approve Admin app confirms a restricted action.
GET /health Liveness check.

The API contract is not final. See hub_brief.md.

Primary Dependencies

  • HTTP server (Go or Python — decide before build).
  • HTTP client for OmniRoute, Home Assistant, Paperclip.
  • MQTT client for voice topics.
  • Tavily API client for web search.

Destinations

Each destination gets one client under src/destinations/. The client calls the destination API. The client does not hold business logic.

Source Control

  • Gitea: sam/central_ai_llm_master
  • Local: /home/sam/paseo/projects/central_ai_llm_master/