Hive
docs(readme): keep feature docs out of readme
GitHub issue · Closed
What changed
This keeps README.md focused on the repository overview instead of feature documentation:
- Updated
AGENTS.mdso future operator and end-user feature changes point contributors to the docs instead ofREADME.md. - Removed detailed
README.mdsections for projects and domains, Model Context Protocol, forage, drops, subscriptions, and Slack.
Why
Feature documentation should live in the docs site, while README.md should remain a concise entry point for the repository.
Approach
The repository overview, Tuist instance link, license note, and docs link stay in place. The feature-specific sections were removed from README.md rather than keeping duplicate public documentation in two locations.
Impact
Contributors now get explicit guidance to update the docs for feature changes. Readers landing on the repository are directed to the docs site for product and self-hosting details.
Validation
rg -n '^## (Projects and domains|Model Context Protocol|Forage|Drops|Subscribe|Slack)$' README.mdrg -n 'README\.md.*user-facing documentation|updateREADME.md|README\.md.*same change' AGENTS.md
Application tests were not run because this only changes Markdown documentation.
Investigate, reproduce, or fix this item in an isolated repository. Each Flight preserves its outcome and agent session.
Start a Flight and preserve its objective, outcome, and session here.
No GitHub comments yet.