Files
WiFiManager/docs/README.md
T

21 lines
1.4 KiB
Markdown

# WiFiManager documentation
| I want to… | Read |
| --- | --- |
| Understand what WiFiManager owns and what the application owns | [Architecture](ARCHITECTURE.md) |
| Start a basic portal or install a released dependency | [Getting started](GETTING_STARTED.md) |
| Choose and operate a provisioning flow | [Provisioning lifecycle](PROVISIONING_LIFECYCLE.md) |
| Brand or constrain the built-in portal | [Portal UI and configuration](PORTAL_UI.md) |
| Add and persist application settings, status, or home cards | [Portal content](PORTAL_CONTENT.md) |
| Configure primary/fallback station profiles or their portal workflow | [Station profiles](STATION_PROFILES.md) |
| Configure AP, station, scan, and reconnect settings | [Network configuration](NETWORK_CONFIGURATION.md) |
| Surface portal and station state in product firmware | [Observability](OBSERVABILITY.md) |
| Look up a supported C++ method and lifecycle rule | [API reference](API_REFERENCE.md) |
| Understand the built-in portal's local JSON protocol | [Portal API](PORTAL_API.md) |
| Apply an existing device-integration pattern | [Recipes](recipes/README.md) |
| Run documentation and board-free compile checks | [Testing](TESTING.md) |
| Build or flash a complete example | [Examples](../examples/README.md) |
| Work on this fork or make a release | [Development and releases](DEVELOPMENT.md) |
Back to the [project overview](../README.md).