feat(network): Adds Network Library documentation#11999
Conversation
👋 Hello SuGlider, we appreciate your contribution to this project! 📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more. 🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project. Click to see more instructions ...
Review and merge process you can expect ...
|
|
You can add the new |
Added documentation for the isOnline() function to check network status.
|
@P-R-O-C-H-Y done |
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive API documentation for the Network library on ESP32 devices. The documentation provides a unified guide for managing multiple network interfaces including Wi-Fi (Station and Access Point), Ethernet, and PPP connections through a centralized NetworkManager.
Key Changes
- Introduces complete Network API documentation covering architecture, interfaces, events, and communication classes
- Documents the NetworkManager as central coordinator with unified interface management
- Provides extensive code examples for Wi-Fi, Ethernet, PPP, and multi-interface scenarios
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Description of Change
Adds documentation for Network Library (Wi-Fi, Ethernet and PPP interfaces, manager and events).
Test Scenarios
CI Only
Related links
None