pantsbuild · thejcannon · Jan 11, 2024 · Jan 10, 2024 · Jan 10, 2024 · Jan 11, 2024
diff --git a/docs/reference/global-options.mdx b/docs/reference/global-options.mdx
@@ -1,5 +1,7 @@
 ---
 title: Global options
+description: |
+  Options to control the overall behavior of Pants.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/check.mdx b/docs/reference/goals/check.mdx
@@ -1,5 +1,7 @@
 ---
 title: check
+description: |
+  Run type checking or the lightest variant of compilation available for a language.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/count-loc.mdx b/docs/reference/goals/count-loc.mdx
@@ -1,5 +1,7 @@
 ---
 title: count-loc
+description: |
+  Count lines of code.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/dependees.mdx b/docs/reference/goals/dependees.mdx
@@ -1,5 +1,7 @@
 ---
 title: dependees
+description: |
+  List all targets that depend on any of the input files/targets.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/dependencies.mdx b/docs/reference/goals/dependencies.mdx
@@ -1,5 +1,7 @@
 ---
 title: dependencies
+description: |
+  List the dependencies of the input files/targets.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/dependents.mdx b/docs/reference/goals/dependents.mdx
@@ -1,5 +1,7 @@
 ---
 title: dependents
+description: |
+  List all targets that depend on any of the input files/targets.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/experimental-bsp.mdx b/docs/reference/goals/experimental-bsp.mdx
@@ -1,5 +1,7 @@
 ---
 title: experimental-bsp
+description: |
+  Setup repository for Build Server Protocol (https://build-server-protocol.github.io/).
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/experimental-deploy.mdx b/docs/reference/goals/experimental-deploy.mdx
@@ -1,5 +1,7 @@
 ---
 title: experimental-deploy
+description: |
+  Perform a deployment process.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/experimental-explorer.mdx b/docs/reference/goals/experimental-explorer.mdx
@@ -1,5 +1,7 @@
 ---
 title: experimental-explorer
+description: |
+  Run the Pants Explorer Web UI server.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/export-codegen.mdx b/docs/reference/goals/export-codegen.mdx
@@ -1,5 +1,7 @@
 ---
 title: export-codegen
+description: |
+  Write generated files to `dist/codegen` for use outside of Pants.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/export.mdx b/docs/reference/goals/export.mdx
@@ -1,5 +1,7 @@
 ---
 title: export
+description: |
+  Export Pants data for use in other tools, such as IDEs.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/filedeps.mdx b/docs/reference/goals/filedeps.mdx
@@ -1,5 +1,7 @@
 ---
 title: filedeps
+description: |
+  List all source and BUILD files a target depends on.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/fix.mdx b/docs/reference/goals/fix.mdx
@@ -1,5 +1,7 @@
 ---
 title: fix
+description: |
+  Autofix source code.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/fmt.mdx b/docs/reference/goals/fmt.mdx
@@ -1,5 +1,7 @@
 ---
 title: fmt
+description: |
+  Autoformat source code.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/generate-lockfiles.mdx b/docs/reference/goals/generate-lockfiles.mdx
@@ -1,5 +1,7 @@
 ---
 title: generate-lockfiles
+description: |
+  Generate lockfiles for third-party dependencies.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/generate-snapshots.mdx b/docs/reference/goals/generate-snapshots.mdx
@@ -1,5 +1,7 @@
 ---
 title: generate-snapshots
+description: |
+  Generate test snapshots.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/go-generate.mdx b/docs/reference/goals/go-generate.mdx
@@ -1,5 +1,7 @@
 ---
 title: go-generate
+description: |
+  Run each command in a package described by a `//go:generate` directive. This is equivalent to running `go generate` on a Go package.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/help-advanced.mdx b/docs/reference/goals/help-advanced.mdx
@@ -1,5 +1,7 @@
 ---
 title: help-advanced
+description: |
+  Help for advanced options.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/help-all.mdx b/docs/reference/goals/help-all.mdx
@@ -1,5 +1,7 @@
 ---
 title: help-all
+description: |
+  Print a JSON object containing all help info.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/help.mdx b/docs/reference/goals/help.mdx
@@ -1,5 +1,7 @@
 ---
 title: help
+description: |
+  Display usage message.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/lint.mdx b/docs/reference/goals/lint.mdx
@@ -1,5 +1,7 @@
 ---
 title: lint
+description: |
+  Run linters/formatters/fixers in check mode.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/list.mdx b/docs/reference/goals/list.mdx
@@ -1,5 +1,7 @@
 ---
 title: list
+description: |
+  Lists all targets matching the file or target arguments.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/package.mdx b/docs/reference/goals/package.mdx
@@ -1,5 +1,7 @@
 ---
 title: package
+description: |
+  Create a distributable package.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/paths.mdx b/docs/reference/goals/paths.mdx
@@ -1,5 +1,7 @@
 ---
 title: paths
+description: |
+  List the paths between two addresses. Either address may represent a group of targets, e.g. `--from=src/app/main.py --to=src/library::`.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/peek.mdx b/docs/reference/goals/peek.mdx
@@ -1,5 +1,7 @@
 ---
 title: peek
+description: |
+  Display BUILD target info
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/publish.mdx b/docs/reference/goals/publish.mdx
@@ -1,5 +1,7 @@
 ---
 title: publish
+description: |
+  Publish deliverables (assets, distributions, images, etc).
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/py-constraints.mdx b/docs/reference/goals/py-constraints.mdx
@@ -1,5 +1,7 @@
 ---
 title: py-constraints
+description: |
+  Determine what Python interpreter constraints are used by files/targets.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/python-dump-source-analysis.mdx b/docs/reference/goals/python-dump-source-analysis.mdx
@@ -1,5 +1,7 @@
 ---
 title: python-dump-source-analysis
+description: |
+  Dump source analysis for python_source targets.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/repl.mdx b/docs/reference/goals/repl.mdx
@@ -1,5 +1,7 @@
 ---
 title: repl
+description: |
+  Open a REPL with the specified code loadable.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/roots.mdx b/docs/reference/goals/roots.mdx
@@ -1,5 +1,7 @@
 ---
 title: roots
+description: |
+  List the repo&#x27;s registered source roots.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/run.mdx b/docs/reference/goals/run.mdx
@@ -1,5 +1,7 @@
 ---
 title: run
+description: |
+  Runs a binary target.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/tailor.mdx b/docs/reference/goals/tailor.mdx
@@ -1,5 +1,7 @@
 ---
 title: tailor
+description: |
+  Auto-generate BUILD file targets for new source files.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/test.mdx b/docs/reference/goals/test.mdx
@@ -1,5 +1,7 @@
 ---
 title: test
+description: |
+  Run tests.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/update-build-files.mdx b/docs/reference/goals/update-build-files.mdx
@@ -1,5 +1,7 @@
 ---
 title: update-build-files
+description: |
+  Format and fix safe deprecations in BUILD files.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/goals/version.mdx b/docs/reference/goals/version.mdx
@@ -1,5 +1,7 @@
 ---
 title: version
+description: |
+  Display Pants version.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/subsystems/add-trailing-comma.mdx b/docs/reference/subsystems/add-trailing-comma.mdx
@@ -1,5 +1,7 @@
 ---
 title: add-trailing-comma
+description: |
+  The add-trailing-comma Python code formatter (https://github.com/asottile/add-trailing-comma).
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/subsystems/anonymous-telemetry.mdx b/docs/reference/subsystems/anonymous-telemetry.mdx
@@ -1,5 +1,7 @@
 ---
 title: anonymous-telemetry
+description: |
+  Options related to sending anonymous stats to the Pants project, to aid development.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/subsystems/apache-thrift.mdx b/docs/reference/subsystems/apache-thrift.mdx
@@ -1,5 +1,7 @@
 ---
 title: apache-thrift
+description: |
+  Apache Thrift IDL compiler (https://thrift.apache.org/).
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/subsystems/autoflake.mdx b/docs/reference/subsystems/autoflake.mdx
@@ -1,5 +1,7 @@
 ---
 title: autoflake
+description: |
+  The Autoflake Python code formatter (https://github.com/myint/autoflake).
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/subsystems/bandit.mdx b/docs/reference/subsystems/bandit.mdx
@@ -1,5 +1,7 @@
 ---
 title: bandit
+description: |
+  A tool for finding security issues in Python code (https://bandit.readthedocs.io).
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/subsystems/black.mdx b/docs/reference/subsystems/black.mdx
@@ -1,5 +1,7 @@
 ---
 title: black
+description: |
+  The Black Python code formatter (https://black.readthedocs.io/).
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/subsystems/buf.mdx b/docs/reference/subsystems/buf.mdx
@@ -1,5 +1,7 @@
 ---
 title: buf
+description: |
+  A linter and formatter for Protocol Buffers (https://github.com/bufbuild/buf).
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/subsystems/build-deprecations-fixer.mdx b/docs/reference/subsystems/build-deprecations-fixer.mdx
@@ -1,5 +1,7 @@
 ---
 title: build-deprecations-fixer
+description: |
+  A tool/plugin for fixing BUILD file deprecations (where possible).
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/subsystems/buildifier.mdx b/docs/reference/subsystems/buildifier.mdx
@@ -1,5 +1,7 @@
 ---
 title: buildifier
+description: |
+  Buildifier is a tool for formatting BUILD files with a standard convention.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/subsystems/changed.mdx b/docs/reference/subsystems/changed.mdx
@@ -1,5 +1,7 @@
 ---
 title: changed
+description: |
+  Tell Pants to detect what files and targets have changed from Git.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/subsystems/cli.mdx b/docs/reference/subsystems/cli.mdx
@@ -1,5 +1,7 @@
 ---
 title: cli
+description: |
+  Options for configuring CLI behavior, such as command line aliases.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/subsystems/coursier.mdx b/docs/reference/subsystems/coursier.mdx
@@ -1,5 +1,7 @@
 ---
 title: coursier
+description: |
+  A dependency resolver for the Maven ecosystem. (https://get-coursier.io/)
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/subsystems/coverage-py.mdx b/docs/reference/subsystems/coverage-py.mdx
@@ -1,5 +1,7 @@
 ---
 title: coverage-py
+description: |
+  Configuration for Python test coverage measurement.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/subsystems/debug-adapter.mdx b/docs/reference/subsystems/debug-adapter.mdx
@@ -1,5 +1,7 @@
 ---
 title: debug-adapter
+description: |
+  Options used to configure and launch a Debug Adapter server.
 ---
 
 import Option from "@site/src/components/reference/Option";

diff --git a/docs/reference/subsystems/debugpy.mdx b/docs/reference/subsystems/debugpy.mdx
@@ -1,5 +1,7 @@
 ---
 title: debugpy
+description: |
+  An implementation of the Debug Adapter Protocol for Python (https://github.com/microsoft/debugpy).
 ---
 
 import Option from "@site/src/components/reference/Option";