-
Notifications
You must be signed in to change notification settings - Fork 2
Open
Labels
enhancementNew feature or requestNew feature or request
Description
Overview
This issue proposes consolidating all repository documentation into a single docs/
directory to make it easier to find, maintain, and eventually publish.
The goal is to have a single source of truth for setup guides, platform-specific guides, the playbook, and contribution guidelines.
Tasks
- Create
docs/
directory if not already created - Move top-level documentation files (
README.adoc
, any existing guides) intodocs/
- Migrate playbook content under
docs/playbook/
- Organize platform-specific documentation into
docs/platform-guides/
- Add basic navigation inside
docs/
(index, getting started guide, etc.) - Evaluate options for publishing the docs:
- MkDocs site (optional future enhancement)
- redis.io (optional future enhancement)
Notes
- Keep current documentation formats for now (Markdown and AsciiDoc are both fine short-term).
- Standardizing on one format (Markdown or AsciiDoc) can be discussed later if needed.
- No significant content rewrites are required — this is mostly restructuring.
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request