docs(opentofu): add synopsis and examples to opentofu commands

Brendan Lynchrequested to merge
8263-add-synopsis-and-examples-to-opentofu-commands into main

Description

Adds Long (Synopsis) fields and Examples to the opentofu command family, as part of the style guide audit identified in #8263 (closed).

  • Adds a Synopsis to the opentofu and opentofu state parent commands.
  • Adds a Synopsis and Examples to opentofu state list, opentofu state lock, and opentofu state unlock.
  • Adds Examples to opentofu state delete (which already had a Synopsis).

Each Synopsis is additive and does not repeat the Short description.

Commands updated:

  • opentofu
  • opentofu state
  • opentofu state list
  • opentofu state lock
  • opentofu state unlock
  • opentofu state delete

Content follows the documentation style guide and the GitLab CLI (glab) documentation style guide.

Related issues and merge requests

Documentation

If this MR adds or updates CLI command documentation, follow the conventions in the GitLab CLI (glab) documentation style guide, run make gen-docs, and commit the updated files in docs/source/.

Merge request reports