docs: rewrite README and add installation guide#386
Merged
Conversation
README is now a concise project overview with supported hardware, requirements, a Docker quick-start using the demo-mode first-start, and a brief How It Works section. Detailed installation steps, a pre-flight checklist, and next-steps guidance are moved to the new docs/getting-started/installation.md page. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refreshes the project’s entry-point documentation by rewriting the root README and adding a dedicated MkDocs “Installation” guide, then wiring that guide into the documentation navigation and landing page.
Changes:
- Rewrites
README.mdto focus on supported systems, requirements, a Docker quickstart, and high-level “How it works”/FAQ content. - Adds a new
docs/getting-started/installation.mdpage covering prerequisites, install paths (Docker/Compose/HA/local), next steps, uninstall, and dev setup. - Registers the new installation page in
mkdocs.ymland updatesdocs/index.mdto link to it.
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| README.md | Reworked top-level project overview and quickstart, linking into the MkDocs installation guide. |
| mkdocs.yml | Adds the new “Installation” page under “Getting Started” navigation. |
| docs/index.md | Updates the docs landing page to point readers to the new installation guide. |
| docs/getting-started/installation.md | New installation guide (Docker/Compose/HA/local), including next steps and dev/test commands. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
| [](https://github.com/MaStr/batcontrol/actions/workflows/docker-image.yml) | ||
|
|
||
| ## Preparations: | ||
| [Documentation](https://mastr.github.io/batcontrol/) — [Home Assistant Add-on](https://github.com/MaStr/batcontrol_ha_addon) |
| ## Requirements | ||
|
|
||
| Alternatively, you can run pytest directly: | ||
| 1. A PV installation with a supported inverter — Fronius Gen24 with a BYD battery, or any system reachable via an MQTT bridge. |
|
|
||
| ## Local Python | ||
|
|
||
| Requires Python 3.13 and [uv](https://docs.astral.sh/uv/). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Test plan
mkdocs serveund Installation-Seite prüfenhttps://mastr.github.io/batcontrol/getting-started/installation/aufrufen🤖 Generated with Claude Code