AI Summary1. Update README.md - Minimal info only, focus on quick start + links to GitHub Pages 2. Update src/CONFIG_README.md - Essential configuration overview + links to full docs 3. Update GitHub Pages ( folder) - Complete, detailed documentation
Install
Copy this and paste it into Claude Code, Cursor, or any AI assistant:
I want to add the "EOS_connect — Copilot Instructions" prompt rules to my project. Repository: https://github.com/ohAnd/EOS_connect Please read the repo to find the rules/prompt file, then: 1. Download it to the correct location (.cursorrules, .windsurfrules, .github/prompts/, or project root — based on the file type) 2. If there's an existing rules file, merge the new rules in rather than overwriting 3. Confirm what was added
Description
EOS Connect is a tool designed to easily collect the needed data for optimize energy usage by interacting with the EOS system or evopt. And will be used as controller for a PV / Battery System and integrates the state of evcc. It displays the results dynamically on a webpage and serve the possibilty to manually override.
Icon Usage
• Always use FontAwesome icons (free tier only) for all documentation and web interfaces • Never use emoji icons - they have been replaced with FontAwesome for consistency and professionalism • The main application icon is located in /docs/assets/images/icon.png and /docs/assets/images/logo.png • FontAwesome CDN: https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.7.2/css/all.min.css
Design Style
• Follow the dark theme established in src/web/css/style.css • Color scheme: • Primary background: rgb(54, 54, 54) • Secondary background: rgb(78, 78, 78) • Accent color: #4a9eff • Border radius: 10px • Maintain responsive design patterns
Documentation
Structure • GitHub Pages documentation is in /docs folder • Structure: 4 main sections (what-is, user-guide, advanced, developer) • Use HTML for documentation pages (better styling control than Markdown) • Keep README.md and CONFIG_README.md concise with links to full docs Documentation Update Workflow When preparing to commit (NEVER stage changed files and commit automatically - always review changes first and ask for confirmation): • Update README.md - Minimal info only, focus on quick start + links to GitHub Pages • Update src/CONFIG_README.md - Essential configuration overview + links to full docs • Update GitHub Pages (/docs folder) - Complete, detailed documentation • Always write from user perspective (except developer section) • Main focus: "Easy entry for new and existing users" • Keep all pages current with latest features and changes • Use clear, practical examples Documentation Perspective • what-is/, user-guide/, advanced/: Write for end users (clear, accessible language) • developer/: Write for contributors (technical details, architecture) • All documentation should help users quickly understand and use EOS Connect • Avoid jargon unless necessary; explain technical concepts simply
Project Role Clarity
• EOS Connect is an integration and control platform, NOT an optimizer • The optimization calculations are performed by external servers: • Akkudoktor EOS Server (https://github.com/Akkudoktor-EOS/EOS) • EVopt (https://github.com/thecem/hassio-evopt) • Always clarify this distinction in documentation and code comments
Discussion
Health Signals
My Fox Den
Community Rating
Sign in to rate this booster
Works With
Any AI assistant that accepts custom rules or system prompts