Hive Hive
Sign in

docs(readme): keep feature docs out of readme

GitHub issue · Closed

Metadata
Source
tuist/hive #69
Updated
Jul 5, 2026
Domains
Hive
Details

What changed

This keeps README.md focused on the repository overview instead of feature documentation:

  • Updated AGENTS.md so future operator and end-user feature changes point contributors to the docs instead of README.md.
  • Removed detailed README.md sections 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.md
  • rg -n 'README\.md.*user-facing documentation|update README.md|README\.md.*same change' AGENTS.md

Application tests were not run because this only changes Markdown documentation.

Flights

Investigate, reproduce, or fix this item in an isolated repository. Each Flight preserves its outcome and agent session.

New Flights are paused Configure model inference, GitHub, and a sandbox provider to start another Flight. Existing results remain available below.
No Flights yet

Start a Flight and preserve its objective, outcome, and session here.

Comments

No GitHub comments yet.