Problem
docs/index.md:70–72 (the documentation site landing page) says:
See the repository README for the full API overview, reference applications, and installation examples.
This sends readers from the rendered documentation site back to GitHub for the primary API reference. A documentation site should be self-contained — users who land on the docs site should not need to navigate away to GitHub to find what they came for.
The docs site already has excellent content covering the API in depth (consumer-profiles, json-contracts, extensions, output-contracts, etc.). The sentence above creates a false impression that the docs site is incomplete.
Fix
Replace the outbound GitHub reference with direct links to the relevant internal pages:
Explore the framework:
- [Consumer profiles](consumer-profiles.md) — project discovery, configuration, runtime ownership
- [JSON and output contracts](json-contracts.md) — machine-readable output schemas
- [Extensions and plugins](extensions.md) — entry-point-based command discovery
- [Typer adapter](typer-adapter.md) — attaching an existing Typer application
The README can remain the entry point for users coming from PyPI, but the docs site should not defer to it.
Problem
docs/index.md:70–72(the documentation site landing page) says:This sends readers from the rendered documentation site back to GitHub for the primary API reference. A documentation site should be self-contained — users who land on the docs site should not need to navigate away to GitHub to find what they came for.
The docs site already has excellent content covering the API in depth (consumer-profiles, json-contracts, extensions, output-contracts, etc.). The sentence above creates a false impression that the docs site is incomplete.
Fix
Replace the outbound GitHub reference with direct links to the relevant internal pages:
The README can remain the entry point for users coming from PyPI, but the docs site should not defer to it.