feat: Simplify README and point to docs site #291
Conversation
Release-As: 2.0.0-beta.1 Signed-off-by: Dan Webb <dan.webb@damacus.io>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| ## History & Credits | ||
|
|
||
| - This project has evolved from the original work by [Richard Mitchell](https://github.com/mitchellrj) and the many contributors over the years. | ||
| - It also builds on work by [Andre Borie](https://gitlab.com/Rjevski/eufy-device-id-and-local-key-grabber) for obtaining local device IDs and keys. |
There was a problem hiding this comment.
🚫 [linkspector] reported by reviewdog 🐶
Cannot reach https://gitlab.com/Rjevski/eufy-device-id-and-local-key-grabber Status: 403
There was a problem hiding this comment.
Pull request overview
This PR simplifies the README by moving detailed documentation to a dedicated documentation site. The main README now serves as a concise entry point with links to comprehensive guides hosted at https://damacus.github.io/robovac, while historical credits are added to the documentation site's index page.
- Condensed README from ~96 lines to ~33 lines by removing detailed installation, debugging, and development instructions
- Added History & Credits section to the documentation site acknowledging original contributors
- Replaced detailed instructions with links to dedicated documentation pages
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Streamlined to provide only essential information with links to full documentation for installation, troubleshooting, and upgrade instructions |
| site_docs/index.md | Added new "History & Credits" section acknowledging the project's evolution and original contributors |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## ⚠️ Breaking Change in v2.0.0 | ||
|
|
||
| This is yet another Eufy fork, this time based on work from [CodeFoodPixels](https://github.com/CodeFoodPixels). | ||
| **Version 2.0.0 requires you to remove and re-add the integration.** See the [upgrade guide](https://damacus.github.io/robovac) for details. |
There was a problem hiding this comment.
The link text claims to point to an "upgrade guide", but the URL just points to the main documentation site homepage (https://damacus.github.io/robovac). There doesn't appear to be a specific upgrade guide page in the site_docs directory. Either create a dedicated upgrade guide page in the documentation or change the link text to something more accurate like "the documentation" or "the installation guide".
| **Version 2.0.0 requires you to remove and re-add the integration.** See the [upgrade guide](https://damacus.github.io/robovac) for details. | |
| **Version 2.0.0 requires you to remove and re-add the integration.** See the [documentation](https://damacus.github.io/robovac) for details. |
1 participant
Release-As: 2.0.0-beta.1
Signed-off-by: Dan Webb dan.webb@damacus.io