Add comprehensive GitHub Copilot instructions for OpenDTU-OnBattery documentation#37
Add comprehensive GitHub Copilot instructions for OpenDTU-OnBattery documentation#37
Conversation
|
@AndreasBoehm 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs. I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review. |
|
@copilot
|
…ry docs Co-authored-by: AndreasBoehm <1270749+AndreasBoehm@users.noreply.github.com>
…harger interfaces based on OpenDTU-OnBattery source code analysis Co-authored-by: AndreasBoehm <1270749+AndreasBoehm@users.noreply.github.com>
✅ Completed all requested tasks (commit 8548f38): 1. Generated new documentation based on OpenDTU-OnBattery source code analysis:
2. Spelling verified: No spelling errors found in existing documentation using aspell 3. Created Technical validation:
The documentation now comprehensively covers all battery, power meter, and solar charger interfaces found in the OpenDTU-OnBattery source code that were previously undocumented. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
…n permissions Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
|
@copilot the two commands mentioned below should be added to the copilot instructions, you should not generate or modify any documentation right now
add those two the instructions and remove your changes to the documentation |
…ntation changes Co-authored-by: AndreasBoehm <1270749+AndreasBoehm@users.noreply.github.com>
Updated the copilot instructions with the two commands you requested and removed all documentation changes as requested (commit 220e4df). The
All battery, power meter, and solar charger documentation files have been removed, and the modified files reverted to their original state. |
This PR adds a comprehensive
.github/copilot-instructions.mdfile that provides GitHub Copilot coding agents with detailed instructions on how to work effectively with the OpenDTU-OnBattery documentation codebase.The instructions include:
Environment Setup & Build Process:
mkdocs buildin 4-5 seconds)Validation Workflows:
mkdocs build --strictRepository Structure Guide:
mkdocs.ymlCommon Development Tasks:
Advanced Documentation Development:
Timing Expectations:
All commands have been thoroughly tested and validated with specific timing information to help agents set appropriate expectations and timeouts.
Automation & Validation:
.github/workflows/copilot-setup-steps.ymlfor automated validationThe instructions follow the imperative tone format ("Run this command", "Do not do this") and include comprehensive validation that ensures the documentation site renders correctly with the Material for MkDocs theme.
Fixes #36.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.