Skip to content

docs: add auto-generated real example output for every function #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mikemadeja merged 1 commit into from
Sep 26, 2026
Merged

docs: add auto-generated real example output for every function #118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ A PowerShell module for automating and scripting against the **Pi-hole v6 REST A
- [Getting an API Password](#getting-an-api-password)
- [Quick Start](#quick-start)
- [Command Reference](#command-reference)
- [Example Output](docs/EXAMPLES.md)
- [Testing](#testing)
- [Contributing](#contributing)
- [License](#license)
Expand Down Expand Up @@ -82,6 +83,8 @@ Every function accepts the same core parameters:

Functions marked 🚧 are still under active development — signatures and output shapes may change. This section is generated from the module's actual exported functions by `tools/Update-ReadmeCommandReference.ps1`, and kept in sync automatically on every `develop` → `main` pull request — don't hand-edit the block below.

See [docs/EXAMPLES.md](docs/EXAMPLES.md) for real, captured output from every function below.

<!-- COMMAND-REFERENCE:START -->
### Actions

Expand Down
Loading
Loading