Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Removed

- **The documentation feature.** The guides are moving to [wpvilla.in](https://wpvilla.in/), so wp-ops no longer searches or links documentation.
- `wp-ops docs` is gone, along with the "the documentation mentions it" hint in `search`.
- The `@doc` manifest directive is gone: the catalog `doc` field, the `Docs:` line in `--help`, the `doc` key in `list --json`, the `docs:` line in the MCP command detail, and the lint that checked the path. The `# @doc` lines are stripped from every script header.
- `command_search` and `command_run` clients that read the `doc` field will no longer see it.

## [5.40.0] - 2026-10-28

### Deprecated
Expand Down
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ sudo mv wp-ops /usr/local/bin/ # or anywhere on your PATH
wp-ops init
```

The scripts, playbooks and guides are embedded in the binary — once it's on your PATH
The scripts and playbooks are embedded in the binary — once it's on your PATH
you can delete the clone.

</details>
Expand All @@ -117,7 +117,6 @@ Running `wp-ops` with no arguments opens an interactive picker of every command:
wp-ops search webp # find a command by name or description
wp-ops backup --help # every command in one category
wp-ops list --platform wordpress # only what works on any WordPress site, Trellis or not
wp-ops docs oom # search the guides
```

More in [Using the CLI](docs/cli/usage.md) and the
Expand Down
28 changes: 2 additions & 26 deletions docs/cli/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,33 +49,9 @@ project you're standing in, `wp-ops db-pull example.com <TAB>` offers
completion, and anything else prints a one-line hint saying what the argument is.
Typing a dash offers the command's own flags.

## Searching the guides
## Guides

A good deal of what this repo knows is written down rather than scripted, so
`wp-ops docs` searches the prose the way `wp-ops search` searches the catalog:

```bash
wp-ops docs # list every guide
wp-ops docs "search-replace" # show matching lines, grouped by document
wp-ops docs oom -w # whole words only (so "oom" skips "server room")
wp-ops docs oom -l # paths only, for piping: wp-ops docs oom -l | xargs $EDITOR
```

When `wp-ops search` finds no command for a term, it checks the documentation and
points you there.

`docs/nginx/`, `docs/troubleshooting/`, and `docs/bedrock/` hold guides and config
templates rather than runnable scripts, so they carry no commands and no CLI
category — reach them through `wp-ops docs`.

Every catalog entry is something that runs. Copy-paste-into-a-theme reference
material — WP-CLI guides and the speed-optimization notes — lives under
`docs/wordpress-utilities/` instead. To pull one into a project, `wp-ops docs -l
<term>` gives you the path:

```bash
cat "$(wp-ops docs -l wp-template | head -1)"
```
wp-ops carries no documentation of its own. The guides live on [wpvilla.in](https://wpvilla.in/), and every command explains itself with `wp-ops <command> --help`.

## Where commands run

Expand Down
8 changes: 0 additions & 8 deletions docs/wordpress-utilities/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,6 @@ Each utility is self-contained and can be integrated independently:
3. Copy the necessary files to your WordPress theme or plugin
4. Follow the installation and configuration instructions

### Via wp-ops

These files are reference guides, not runnable scripts. Find them with `wp-ops docs`:

```bash
wp-ops docs -l wp-template # print the path of the matching guide
```

### General Prerequisites

Most utilities may require one or more of:
Expand Down
6 changes: 2 additions & 4 deletions docs/wordpress-utilities/speed-optimization/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,8 @@ Measuring TTFB with `curl` and `wget`, the 0.8 s / 1.8 s thresholds, and why to
Two runnable scripts back the manual `curl`/`wget` checks above with repeatable,
averaged measurements. They live in
[`scripts/monitoring/`](../../../scripts/monitoring/), not this folder — everything
under `wordpress-utilities/` is treated by the `wp-ops` CLI as a copy-paste
reference snippet (printed or clipboard-copied, never executed), which doesn't
fit an actual runnable tool. This README stays the docs home; `@doc` on both
scripts points back here.
under `wordpress-utilities/` is reference material, which doesn't fit an
actual runnable tool.

- [`../../scripts/monitoring/ttfb-test.sh`](../../../scripts/monitoring/ttfb-test.sh) —
runs `curl` against a URL 5 times from your machine, averages
Expand Down
281 changes: 0 additions & 281 deletions go/cmd/docs.go

This file was deleted.

Loading
Loading