Description
The current README.md is extremely comprehensive but has become too long for quick scanning. It currently exceeds the optimal length for a landing page, forcing users to scroll past 15+ sections to find installation or contribution guidelines. We need to move detailed feature breakdowns to a dedicated /docs folder or a Wiki.
Requirements
- Create a
/docs Directory: Move in-depth command explanations (Ticket System, Starboard, Counting Game, etc.) into individual markdown files (e.g., docs/TICKETS.md, docs/GAMES.md).
- Simplify Landing Page: The main
README.md should only contain:
- Project High-level Overview
- Quick Start / Installation
- Essential Environment Variables
- A Feature Index with links to the new files in /docs.
- Add a Table of Contents: Implement a clickable "Quick Links" section at the top of the README.
- Collapsible Sections: Use HTML
<details> tags for secondary information like "Fun Commands" or "Acknowledgments" to keep the UI clean.
Proposed Structure
Eigen-bot/
├── README.md (The "Hub")
└── docs/
├── FEATURES.md (Full command list)
├── SETUP_GUIDE.md (Detailed Environment & Docker config)
├── TICKETS.md (Deep dive into the support system)
└── CONTRIBUTING.md (Guidelines for devs)
Acceptance Criteria
Description
The current
README.mdis extremely comprehensive but has become too long for quick scanning. It currently exceeds the optimal length for a landing page, forcing users to scroll past 15+ sections to find installation or contribution guidelines. We need to move detailed feature breakdowns to a dedicated/docsfolder or a Wiki.Requirements
/docsDirectory: Move in-depth command explanations (Ticket System, Starboard, Counting Game, etc.) into individual markdown files (e.g.,docs/TICKETS.md,docs/GAMES.md).README.mdshould only contain:- Project High-level Overview
- Quick Start / Installation
- Essential Environment Variables
- A Feature Index with links to the new files in
/docs.<details>tags for secondary information like "Fun Commands" or "Acknowledgments" to keep the UI clean.Proposed Structure
Acceptance Criteria
README.mdreduced by at least 60% in length./docsfolder are verified.