Add Doxygen auto-documentation with CI/CD integration

[Copilot]

Implements automated documentation generation for the ESP32 Bitcoin miner codebase.

Changes

Documentation Infrastructure

• Doxyfile: Doxygen config with call graphs, HTML output, recursive scanning
• .github/workflows/documentation.yml: Auto-generates docs on push, deploys to GitHub Pages, archives artifacts (90d retention)
• generate_docs.sh: Local doc generation script with dependency checks

Code Documentation

• main/ssd1306.h: Doxygen comments for all API functions (5) and structures
• main/main.c: Function docs covering mining core (SHA256, difficulty), initialization (WiFi, I2C), and utilities (pin sweep)
• Configuration constants and parameters documented inline

Repository Hygiene

• .gitignore: Excludes docs/, html/, latex/ directories
• README.md: Usage instructions, installation guide, GitHub Pages link

Usage

# Local generation
./generate_docs.sh

# Manual
doxygen Doxyfile

# CI/CD
# Automatic on push to main, deploys to https://v-Kaefer.github.io/esp32-solominer/

Example Output

/**
 * @brief Compute double SHA256 hash
 * 
 * Performs two rounds of SHA256 hashing as required by Bitcoin protocol.
 * 
 * @param data Input data to hash
 * @param len Length of input data in bytes
 * @param hash Output buffer for 32-byte hash result
 */
void double_sha256(const uint8_t* data, size_t len, uint8_t* hash);

Generated documentation includes cross-references, call graphs, dependency diagrams, and full-text search.

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:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Original prompt

Add auto documentation

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.