Skip to content

Streamline Documentation & Add Docker Guide#75

Open
3akare wants to merge 7 commits intoadd-license-1from
61-guide-for-local-end-to-end-testing-of-hyphae-apis
Open

Streamline Documentation & Add Docker Guide#75
3akare wants to merge 7 commits intoadd-license-1from
61-guide-for-local-end-to-end-testing-of-hyphae-apis

Conversation

@3akare
Copy link
Member

@3akare 3akare commented Jan 20, 2026

I have restructured the documentation to reduce README clutter and introduce a containerized setup option.

Changes:

  • Refactored Installation: Moved the lengthy native host instructions to docs/INSTALL_HOST.md.
  • Added Docker Guide: Created docs/INSTALL_DOCKER.md for standardized container testing.
  • Simplified README: Replaced walls of text with a clean "Quick Start" and links to the specific guides in docs/.

Reasoning: The README was becoming too large. Separating the guides makes the landing page more readable while providing clear paths for both hardware users (Native) and developers (Docker).

Added a comprehensive guide for installing Docker and troubleshooting common issues related to the setup, including environment configuration, service management, and MongoDB installation.

Signed-off-by: 3akare <bakaredavid007@gmail.com>
Updated the installation guide to improve clarity and organization. Merged sections and added important notes for prerequisites and troubleshooting.

Signed-off-by: 3akare <bakaredavid007@gmail.com>
Removed the old installation guide and added new installation options for Docker and Native Host.

Signed-off-by: 3akare <bakaredavid007@gmail.com>
Signed-off-by: 3akare <bakaredavid007@gmail.com>
Updated formatting and section headings in the README.

Signed-off-by: 3akare <bakaredavid007@gmail.com>
Removed duplicate permission denied message and unnecessary question about merging guides.

Signed-off-by: 3akare <bakaredavid007@gmail.com>
Added installation section with recommendations for Native Host and Docker setups.

Signed-off-by: 3akare <bakaredavid007@gmail.com>
@3akare 3akare self-assigned this Jan 20, 2026
@3akare 3akare added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 20, 2026
@3akare 3akare linked an issue Jan 20, 2026 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Guide for Local End-to-End Testing of hyphae APIS

1 participant