Repository navigation
docs: overhaul project documentation to current runtime - #51
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/tree with six guides (architecture, API, local backend, providers, workflows, desktop UI).Changes
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.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.example.yaml(tracked) plus the untracked/gitignoredllm-proxy.config.yamlandllama-swap.config.yaml; cleaned their dead.gitignoreentries; rewroteopenspec/specs/config-load/spec.mdfrom the deleted config-file system to the env-drivenresolveAppConfigreality (7 requirements / 15 scenarios); fixed the stale openspec architecture line.Testing
bun run typecheck— passbun run lint— passbun test— 462 pass / 0 fail (42 files)typecheck:frontendand frontend tests remain local-only gates; CI currently gates lint, backend typecheck, andbun test. Size exception: ~1,950 lines, 100% documentation — each of the 3 work-unit commits is independently reviewable.Closes nothing (docs-only).