Skip to content

docs: overhaul README for clarity and modern design - #32

Merged
Kubaguette merged 4 commits into
mainfrom
restructure-readme
May 10, 2026
Merged

docs: overhaul README for clarity and modern design#32
Kubaguette merged 4 commits into
mainfrom
restructure-readme

Conversation

@Kubaguette

Copy link
Copy Markdown
Owner

Description

This PR drastically improves the readability, flow, and visual structure of our README.md to ensure a better onboarding experience for new users.

Key changes:

  • Modernized "Why EnvStation?": Rewrote the value proposition to directly address the "split-brain" container problem on immutable distributions. Implemented a clean, progressive disclosure design using <details> and <blockquote> tags to keep the main view uncluttered while preserving technical depth.
  • Streamlined "Quick Start": Removed the deprecated AppImage references and condensed the installation guide into scannable, easy-to-read code blocks.
  • General Polish: Removed "walls of text" while maintaining necessary information.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring / Documentation update

Architecture Checklist:

  • My code follows the ARCHITECTURE.md guidelines.
  • I have routed system commands through the Host-Executor (build_host_command_async) where necessary. (N/A - Docs only)
  • I have performed a self-review of my own code.

@Kubaguette Kubaguette self-assigned this May 10, 2026
@Kubaguette
Kubaguette merged commit b71775f into main May 10, 2026
2 checks passed
@Kubaguette
Kubaguette deleted the restructure-readme branch May 10, 2026 01:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant