Skip to content

Comments

Add comprehensive GitHub Copilot instructions for OpenDTU-OnBattery documentation#37

Draft
Copilot wants to merge 5 commits intomainfrom
copilot/fix-36
Draft

Add comprehensive GitHub Copilot instructions for OpenDTU-OnBattery documentation#37
Copilot wants to merge 5 commits intomainfrom
copilot/fix-36

Conversation

Copy link

Copilot AI commented Sep 12, 2025

This PR adds a comprehensive .github/copilot-instructions.md file 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:

  • Complete Python virtual environment setup (3 seconds)
  • MkDocs dependency installation process (27 seconds)
  • Fast build commands (mkdocs build in 4-5 seconds)
  • Development server setup with live reload

Validation Workflows:

  • Strict mode building with mkdocs build --strict
  • Manual validation scenarios for testing changes
  • End-to-end validation procedures
  • Expected warnings and how to handle them

Repository Structure Guide:

  • Key directories and file locations (73+ markdown files)
  • Navigation configuration in mkdocs.yml
  • Asset and content organization
  • CI/CD pipeline understanding

Common Development Tasks:

  • Adding new documentation pages
  • Modifying existing content with live reload
  • Configuration changes and testing
  • Troubleshooting build issues

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:

  • Copilot Setup Workflow: Created .github/workflows/copilot-setup-steps.yml for automated validation
  • Environment Verification: Automated testing of documentation build process
  • Repository Structure Validation: Comprehensive checks for required files and directories

The 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.

Working OpenDTU-OnBattery documentation site

Fixes #36.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copy link
Author

Copilot AI commented Sep 12, 2025

@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.

@AndreasBoehm
Copy link
Member

@copilot

…ry docs

Co-authored-by: AndreasBoehm <1270749+AndreasBoehm@users.noreply.github.com>
Copilot AI changed the title [WIP] Set up Copilot instructions Add comprehensive GitHub Copilot instructions for OpenDTU-OnBattery documentation Sep 12, 2025
Copilot AI requested a review from AndreasBoehm September 12, 2025 06:04
…harger interfaces based on OpenDTU-OnBattery source code analysis

Co-authored-by: AndreasBoehm <1270749+AndreasBoehm@users.noreply.github.com>
Copy link
Author

Copilot AI commented Sep 12, 2025

@copilot

Completed all requested tasks (commit 8548f38):

1. Generated new documentation based on OpenDTU-OnBattery source code analysis:

  • Battery Interfaces: Added comprehensive docs for JBD BMS, Pytes, SBS (Smart Battery System), and Zendure SuperBase - all found in source code but previously undocumented
  • Power Meter Interfaces: Created complete guide for SML, SDM (Eastron), JSON HTTP, and UDP interfaces from /src/powermeter/ analysis
  • Solar Charger Interfaces: Documented Victron VE.Direct and MQTT interfaces from /src/solarcharger/ analysis

2. Spelling verified: No spelling errors found in existing documentation using aspell

3. Created .github/workflows/copilot-setup-steps.yml: Comprehensive workflow for automated OpenDTU-OnBattery documentation validation and setup

Technical validation:

  • Documentation builds successfully with mkdocs build (4.5 seconds)
  • Development server runs correctly with live reload
  • All new content integrated into navigation structure
  • Cross-references and MQTT topic structures documented

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:

  • esm.ubuntu.com
    • Triggering command: /usr/lib/apt/methods/https (dns block)

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 AI changed the title Add comprehensive GitHub Copilot instructions for OpenDTU-OnBattery documentation Add comprehensive GitHub Copilot instructions and extensive documentation for OpenDTU-OnBattery Sep 12, 2025
@AndreasBoehm
Copy link
Member

@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>
Copy link
Author

Copilot AI commented Sep 12, 2025

@copilot the two commands mentioned below should be added to the copilot instructions, you should not generate or modify any documentation right now

Updated the copilot instructions with the two commands you requested and removed all documentation changes as requested (commit 220e4df). The .github/copilot-instructions.md now includes:

All battery, power meter, and solar charger documentation files have been removed, and the modified files reverted to their original state.

Copilot AI changed the title Add comprehensive GitHub Copilot instructions and extensive documentation for OpenDTU-OnBattery Add comprehensive GitHub Copilot instructions for OpenDTU-OnBattery documentation Sep 12, 2025
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.

Set up Copilot instructions

2 participants