docs: refresh public project guidance#48
Merged
Conversation
ferueda
marked this pull request as ready for review
July 18, 2026 18:47
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
Why
The public entry point repeated detailed CLI, storage, indexing, and performance contracts that already have focused owners. The roadmap also still said M12 rollout was pending after
0.1.0and0.1.1were published and verified. This made the repository harder for humans and agents to install, understand, and maintain.Impact
No runtime behavior, CLI schema, storage contract, or privacy boundary changes. README drops from 255 to 133 lines and the roadmap from 1,685 to 142 lines. Exact behavior remains in the CLI, structured-output, privacy, architecture, and provider references.
Verification
pnpm check:docspnpm check— 107 test files / 1,107 tests, build, dist smoke, and package smokedocs-drift-review— one stale architecture wording issue found and fixed; no advisory bloat findings