docs: use bundled knowledge directions in README examples - #5
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.
What changes
The English and Chinese README direction examples now use
agent_memoryandllm_reasoning, both included inknowledge_base/. The instructions also explain that a custom knowledge file must exist before its name is added to the configuration.Why
Copying the previous example into
config/providers.local.jsoncausedpython run_pending_forge.pyto reject both names before model execution. This was an incorrect documentation example. Runtime validation correctly rejects unknown directions and remains unchanged.Validation
ValueError; the corrected example reaches the Forge call with the intended directions. Model execution was intercepted at that boundary; no paid model request was made.Scope check
Fixes #1