docs(readme): drop Approval flow, Embedding, Related repos, Status sections#76
Merged
Conversation
…atus sections Removes four sections that were stale, redundant, or out of scope for a README: - Approval flow — duplicates information conveyed by the CLI help and approval module docs - Embedding in your own Python host — example had a nonexistent mcp_config_path parameter that would crash at runtime; the embedding API is better documented in the library source itself - Related repositories — went stale (wrong repo name) and adds little for a reader landing on this README - Status — version number was stale (0.8.0 vs actual 0.9.0) and roadmap items belong in CHANGELOG.md / GitHub Releases, not a README File drops from 439 to 361 lines. No other sections touched. Generated with [Amplifier](https://github.com/microsoft/amplifier) Co-Authored-By: Amplifier <240397093+microsoft-amplifier@users.noreply.github.com>
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
Removes four README sections that were stale, redundant, or out of scope for a project README.
What's removed
## Approval flow## Embedding in your own Python hostmcp_config_pathparameter); the embedding API is better documented insrc/amplifier_agent_lib/itself## Related repositoriesopenclawvs actualnanoclaw) and adds little for a reader on this README## Status0.8.0vs actual0.9.0); roadmap belongs in CHANGELOG / GitHub ReleasesStats
File drops from 439 to 361 lines. No other sections edited.
Verification
grep "^## " README.mdshows 16 sections (down from 20), in the right order🤖 Built with Amplifier) deliberately left intact — not in scope of this scrubOther stale items not touched
The earlier audit flagged a few small fixes that are out of scope for this PR but worth tracking:
--config <path-to-yaml>should be<path-to-json>(2 places: lines 123 and the wire protocol flags table)## Admin commandsis missing theservefamily (serve chat-completions,serve status,serve stop,serve restart)