Instruction file imported from sandiegoi-PV/AI_PVSim (.github/instructions/documentation.instructions.md). Copyright stays with the author.

Documentation Guidelines for AI_PVSim

Markdown Style

• Use proper heading hierarchy (start with h1, don't skip levels)
• Include a table of contents for longer documents
• Use code blocks with language specifiers for syntax highlighting
• Keep line length reasonable for readability

Content Guidelines

• Write clear, concise explanations
• Include practical examples
• Use diagrams or images when they add clarity
• Keep documentation up-to-date with code changes

README Structure

• Project description and purpose
• Installation instructions
• Usage examples
• Contributing guidelines
• License information

Technical Documentation

• Explain the "why" not just the "what"
• Include formulas and equations using LaTeX notation when needed
• Provide references to academic papers or standards
• Include units and physical context for PV-related values