docs: revamp README as storefront for docs site#251
Merged
danielmeppiel merged 2 commits intomainfrom Mar 11, 2026
Merged
Conversation
- Remove badges, detailed reference tables, and duplicate content - Funnel to docs site (microsoft.github.io/apm/) for deep dives - Keep compliance tagline, open standards footer, trademarks - Supported agents: GitHub Copilot, Claude Code - 250 lines → ~80 lines (uv-pattern approach)
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors README.md to act as a lightweight “storefront” that points users to the hosted documentation site, rather than duplicating reference content in the repo README.
Changes:
- Replaces the long-form README content with a shorter value proposition + highlights section.
- Adds prominent links to the docs site (Docs / Quick Start / CLI Reference).
- Simplifies examples and installation instructions, removing detailed reference sections now covered by the docs.
Comments suppressed due to low confidence (1)
README.md:43
- This line implies
apm compileoutputs AGENTS.md specifically for GitHub Copilot, but the documentation states AGENTS.md is also consumed by other agents/tools (e.g., Cursor/Codex, and generally the AGENTS.md standard). Consider broadening the parenthetical or rewording it to avoid narrowing the compatibility story compared to the docs site.
- **Compile to standards** — `apm compile` produces `AGENTS.md` (GitHub Copilot) and `CLAUDE.md` (Claude Code)
| - **Install from anywhere** — GitHub, GitLab, Bitbucket, Azure DevOps, GitHub Enterprise, any git host | ||
| - **Transitive dependencies** — packages can depend on packages; APM resolves the full tree | ||
| - **Compile to standards** — `apm compile` produces `AGENTS.md` (GitHub Copilot) and `CLAUDE.md` (Claude Code) | ||
| - **Create & share** — `apm pack` bundles your current configuration as a zipped package |
There was a problem hiding this comment.
apm pack is described as producing a "zipped" package, but the docs describe apm pack --archive as producing a .tar.gz archive (and without --archive it outputs a directory bundle). To avoid misleading users, consider rephrasing this as "portable bundle" / ".tar.gz archive" and/or mention the --archive flag.
Suggested change
| - **Create & share** — `apm pack` bundles your current configuration as a zipped package | |
| - **Create & share** — `apm pack` bundles your current configuration as a portable bundle (directory by default, or `.tar.gz` archive with `--archive`) |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This was referenced Mar 12, 2026
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
Now that the docs site is live at microsoft.github.io/apm/, the README no longer needs to serve as both landing page AND reference manual.
This PR revamps the README following the uv pattern (benchmarked against uv, ruff, deno, bun) — enough content to convey the value proposition without clicking away, but funneling to the docs site for everything else.
What changed
docs/paths250 lines → ~80 lines
Constraints respected
**An open-source, community-driven dependency manager for AI agents.**kept verbatim (Microsoft compliance)