docs(readme): Table of Contents + 'Start here' orientation#17
Merged
Conversation
The content + code examples were already strong and accurate; the gap was navigability — no ToC, and the doc led with a CLI dump + a long design bullet list before orienting a newcomer. Adds: - an anchored Table of Contents over the existing sections, and - a "Start here" router: CLI (author/inspect by hand) vs the programmatic primitive picked by intent (buildEvalKnowledgeBundle / runKnowledgeResearchLoop / researcher profile / runKnowledgeBaseOptimization / pluggable sources). No API churn — all existing repo-specific examples are accurate and unchanged.
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
2 participants
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.
The agent-knowledge README's content + examples were already strong and accurate; the gap was navigability. Adds an anchored Table of Contents and a 'Start here' router (CLI for hand-authoring vs the programmatic primitive picked by intent). No API churn — every existing repo-specific example is unchanged.