docs: point the README at the docs site and keep only the plugin contract

[earakely-scale]

The user guide now lives at www.agentenvframework.com/docs, so the README points there. It goes from 235 KB to 46 KB (2,032 lines to 334).

What the README keeps

Section	Why
Logo and opening paragraph	The front door, unchanged
Documentation link	Where the user guide is
Install	Down to git clone https://github.com/scaleapi/agentenv-framework, uv sync --extra dev and activate. This replaces the old <repo-url> placeholder. It stays because neither package is on PyPI yet.
Plugin contract, verbatim	Everything from "Register types from an installed package" through "Plugin compatibility". Two unit tests read "Plugin report format" and "The plugin surface". check_plugin_api.py and the docstrings in agent_env/plugins/ cite these sections as the contract.
Contribute, release, license, shortened	The CONTRIBUTING/AGENTS pointer, the documentation map (now listing the docs site), versioning, releases, support

Three in-page links pointed into removed sections:

• The two to "Inspect the resolved configuration" now name agent-env config show.
• The one to the CLI reference's deprecated aliases is dropped.

Every remaining in-page and file link has a target.

Checked

• Full unit tier: 5,611 passed, 13 skipped.
• twine check passes on the wheel and the sdist. This README is the PyPI description.

Follow-ups not in this PR

• Gaps on the docs site: some removed content isn't there yet. Getting Started, the CLI reference, Python API and Troubleshooting are still stubs, and the configuration reference and Run on Google Cloud guide have no page. They're recoverable from git history.
• AGENTS.md still calls the README the user-facing front door for configuration, envs, steps and the CLI.
• config/loader.py's docstring still says to see the README for the config schema.

🤖 Generated with Claude Code

Confidence Score: 4/5

The PR appears safe to merge, but the removed user guides should stay reachable until their replacement pages are ready.

Findings

1.  Getting started guide is missing ▶

Fix with agent prompt

### Issue 1
README.md:10
The `README.md` now sends new users to the docs site and removes its working quickstart, CLI reference, and configuration guide. The PR description says the getting-started and CLI pages are still stubs, and the configuration reference has no page. Readers cannot find those instructions through the replacement link. Please keep the removed guides reachable until their replacements are ready.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Summary

The README now sends user-guide readers to the hosted docs and keeps a short install path and the plugin contract. It also shortens the project pointers and updates references affected by the removed sections.

• Adds links to the docs site at the top of the README and in its documentation map.
• Keeps clone-based install steps because neither package is on PyPI yet.
• Retains the plugin contract sections used by tests and the plugin API check.

_{Reviews (1) · Last reviewed commit: "docs: point the README at the docs site ..."}

[greptile-apps]

Getting started guide is missing

The README.md now sends new users to the docs site and removes its working quickstart, CLI reference, and configuration guide. The PR description says the getting-started and CLI pages are still stubs, and the configuration reference has no page. Readers cannot find those instructions through the replacement link. Please keep the removed guides reachable until their replacements are ready.

Prompt To Fix With AI

This is a comment left during a code review.
Path: README.md
Line: 10

Comment:
**Getting started guide is missing**

The `README.md` now sends new users to the docs site and removes its working quickstart, CLI reference, and configuration guide. The PR description says the getting-started and CLI pages are still stubs, and the configuration reference has no page. Readers cannot find those instructions through the replacement link. Please keep the removed guides reachable until their replacements are ready.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!