docs: add root README, per-package READMEs, and logo assets#7
Merged
Conversation
Adds a root README that explains what agnos is and why we built it, walks through a quickstart, and includes an end-to-end example of authoring a custom agent plugin. Each workspace package now has its own README covering scope, install, and usage. Introduces SVG logo and banner assets under .github/assets/ for use in the root README header.
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
1 participant
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
README.mdthat explains what agnos is, why we built it, how it works, and walks through authoring a custom agent plugin end-to-end (package.json registration + TypeScript implementation).@luxia/core,@luxia/agnos, the two agent plugins (agent-claude-code,agent-codex), and the four domain plugins (domain-rules,domain-mcp,domain-skills,domain-docs). Each covers scope, install, configuration, and CLI surface..github/assets/(hub-and-spokes mark with a#FF4040center node) used in the root header.Why
The repo had no top-level README and the umbrella package's README was a stub. New users had no entry point and no template for building their own agent plugin, which is the whole point of the plugin-driven design.