Skip to content

docs: overhaul project documentation to current runtime - #51

Merged
AndyTechnologies merged 4 commits into
masterfrom
docs/docs-overhaul
Sep 24, 2026
Merged

AndyTechnologies merged 4 commits into
masterfrom
docs/docs-overhaul

Conversation

@AndyTechnologies

Copy link
Copy Markdown
Owner

Summary

  • Bring every documentation artifact in the repo up to date with the current runtime (post backend-wiring + admin console): README, AGENTS, CONTRIBUTING, CHANGELOG, and the openspec config-load spec.
  • Fill the empty docs/ tree with six guides (architecture, API, local backend, providers, workflows, desktop UI).
  • Remove the dead legacy root config files and their references.

Changes

  • Root docs: README now reflects the wired local backend (hub + restoreActive, 10-min idle, /api/models* lifecycle), the env-driven config (WEAVELLM_UI_DIR, WEAVELLM_LLAMA_BIN, ephemeral port), the admin console served by the app, and the real scripts table. AGENTS drops the stale "boot wiring limitation" block. CONTRIBUTING rewritten with the real layout, gates, 25-spec list. CHANGELOG gains the admin-console/wiring entries.
  • docs/ (new): architecture.md, api.md (HTTP + WS surface), local-backend.md (llama-server lifecycle, activation, embeddings), providers.md (registry, keychain scopes, fallback), workflows.md (DAG/YAML, 14 node types, gateway virtuals), desktop-ui.md (Astro 7 console, pages, dev/build flows). Every claim cross-checked against source.
  • Config cleanup: removed config.example.yaml (tracked) plus the untracked/gitignored llm-proxy.config.yaml and llama-swap.config.yaml; cleaned their dead .gitignore entries; rewrote openspec/specs/config-load/spec.md from the deleted config-file system to the env-driven resolveAppConfig reality (7 requirements / 15 scenarios); fixed the stale openspec architecture line.

Testing

  • bun run typecheck — pass
  • bun run lint — pass
  • bun test — 462 pass / 0 fail (42 files)
  • No dangling references to the removed configs in active files (only historical openspec archives + intentional "SHALL NOT be honored" wording in the new spec)
  • Note: typecheck:frontend and frontend tests remain local-only gates; CI currently gates lint, backend typecheck, and bun test. Size exception: ~1,950 lines, 100% documentation — each of the 3 work-unit commits is independently reviewable.

Closes nothing (docs-only).

@AndyTechnologies
AndyTechnologies merged commit 4ef473f into master Sep 24, 2026
3 checks passed
@AndyTechnologies
AndyTechnologies deleted the docs/docs-overhaul branch September 24, 2026 18:06
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