Documenting an operation

Every operation that is added to rxchef should ideally come with documentation that explains what it does, what inputs it expects, and what arguments are available.

Good documentation contains

  • a short summary of the operation,
  • the main use case,
  • a list of arguments and defaults,
  • examples of common input/output,
  • and cross-links to related functionality when useful.
  1. add or update the operation’s page in the operations docs,
  2. keep names and descriptions aligned with the registry,
  3. ensure examples are realistic and easy to copy,
  4. and validate that the generated documentation still builds.