docs: catch up README + design docs through the PR #36-#44 chain #45
No reviewers
Labels
No labels
bug
commercial
documentation
duplicate
enhancement
feature
good first issue
help wanted
invalid
question
wontfix
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
jasoncouture/llama-shears!45
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "docs/post-pr44-sweep"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Summary
/clear,/archive,/compact,/restart,/interrupt), and the cron stub.docs/design/architecture.mdgains rows/sections forProvider.OpenAI,Abstractions.Commands,IHostRestarter, the<DataRoot>/appsettings.jsonoverlay, and new cross-cutting Slash commands + Cron subsystem sections.docs/design/paths.mdaddsOpenAIProviderOptionsto the configuration knobs and documents the<DataRoot>/appsettings.jsonoverlay precedence chain.docs/quickstart.mdmentions OpenAI-compatible backends in the prerequisites and theOPENAI/<model>prefix in the agent-config snippet.Test plan
🤖 Generated with Claude Code
Pull request overview
Documentation update to reflect recent feature additions across the PR #36–#44 chain (OpenAI-compatible provider, slash command system, and cron stub) and to clarify configuration/paths behavior.
Changes:
architecture.md,paths.md) with new subsystem sections and configuration overlay details.Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
OpenAIProviderOptionsand<DataRoot>/appsettings.jsonoverlay + precedence.💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
The Cron tool names are inconsistent with the MCP tool attributes in
src/LlamaShears.Api/Tools/ModelContextProtocol/Cron/*: the tools arecron_list,cron_edit,cron_cancel, andcron_trigger(notlist/edit/cancel/trigger). Update the documentation to use the full tool names so users can actually invoke them.@ -12,3 +12,3 @@|---------|------|| [src/LlamaShears](../../src/LlamaShears/) | ASP.NET Core entry point. `Program.cs`, `appsettings.json`, bundled workspace templates under `content/templates/workspace/`, the `TemplateSeedingStartupTask` that copies them into `<Templates>` on first boot, and the in-host plugin wire-up (`PathPluginLoader` + `LoadPluginsAsync`/`UsePluginsAsync`). || [src/LlamaShears](../../src/LlamaShears/) | ASP.NET Core entry point. `Program.cs`, `appsettings.json`, bundled workspace templates under `content/templates/workspace/`, the `TemplateSeedingStartupTask` that copies them into `<Templates>` on first boot, and the in-host plugin wire-up (`PathPluginLoader` + `LoadPluginsAsync`/`UsePluginsAsync`). `Program.cs` resolves `<DataRoot>` (defaulting to `~/.llama-shears`, with `~` expansion) before any service registration and inserts a reload-on-change `JsonConfigurationSource` for `<DataRoot>/appsettings.json` immediately after the bundled JSON sources — i.e. it overrides `appsettings.json` / `appsettings.{Env}.json` / user-secrets, but environment variables and command-line args still win. |Program.csinserts the<DataRoot>/appsettings.jsonsource after the lastJsonConfigurationSource. That means it overridesappsettings*.json, but it does not override later non-JSON sources (and this repo doesn't configure user-secrets at all). The sentence claiming it overrides user-secrets should be corrected to match the actual configuration precedence.@ -36,3 +36,4 @@| [src/LlamaShears.Provider.OpenAI](../../src/LlamaShears.Provider.OpenAI/) | OpenAI-compatible chat provider. Speaks `/v1/chat/completions` (streaming) and `/v1/models`, so it covers any OpenAI-API-compatible backend — `llama-server`, vLLM, LM Studio, TabbyAPI, the real OpenAI endpoint. `OpenAIProviderOptions.ExtraRequestParams` is a free-form `JsonObject` merged into every request body so vendor knobs round-trip without forking the provider; per-agent options deep-merge over host defaults. Single `IHttpClientFactory` named client (`nameof(OpenAILanguageModel)`) is shared between the language model and the listing call. || [src/LlamaShears.Provider.Onnx.Embeddings](../../src/LlamaShears.Provider.Onnx.Embeddings/) | In-process embeddings provider for sentence-transformers-style ONNX models (currently scoped to all-MiniLM family). Convention-based per-model layout under `<Templates>`/configured paths; pooling strategy + max-sequence-length per model. |### Public abstractions (`src/public/`)This row reads as though
IHostRestarteris used byTemplateSeedingStartupTaskandAgentManager, but those types only useIHostStartupTask/HostStartupTaskRunner. Consider rewording to separate the two concerns (startup tasks vs. restarter) so the dependency/usage claims stay accurate.@ -97,0 +106,4 @@4. user-secrets5. `appsettings.{Environment}.json`6. `appsettings.json`The
<DataRoot>/appsettings.jsonprecedence list doesn't match the actual insertion logic insrc/LlamaShears/Program.cs: the overlay is inserted after the lastJsonConfigurationSource, which places it before any non-JSON sources (and there is noUserSecretsIdin this repo, so user-secrets aren't configured by default). Please adjust the precedence list/wording (and remove or reposition the user-secrets bullet) so it reflects the real override order.