docs: README overhaul — landing page + docs/ directory#127
Merged
Conversation
97cad22 to
14bb962
Compare
README was 1911 lines with 93 sections. Rewrote as a landing page: install, quick start, command table, production setup. Moved detailed docs to docs/ directory (setup, commands, production, server, integrations, vscode, security). Co-authored-by: Ona <no-reply@ona.com>
14bb962 to
d3783ae
Compare
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
README: 1911 lines → 188 lines. No content deleted — relocated to
docs/.Before / after
New docs/ files
docs/setup.mddocs/commands.mddocs/production.mddocs/server.mddocs/integrations.mddocs/vscode.mddocs/security.mdREADME structure (new)
AGENTS.md changes
docs/section table with all 7 new files0.51.0Verification
cli.pydispatch tabledocs/links in README resolve to existing filespython -m pytest tests/ -q)docs/