documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Have a process to ensure the events and commands reference is kept up-to-date

Open bergundy opened this issue 3 years ago • 1 comments

We have these 2 concept pages in the docs that contains duplicate and sometimes outdated information relative to the source.

Docs:

  • https://docs.temporal.io/references/events
  • https://docs.temporal.io/references/commands

Source:

  • https://github.com/temporalio/api/blob/master/temporal/api/history/v1/message.proto
  • https://github.com/temporalio/api/blob/master/temporal/api/command/v1/message.proto

With new features like sync update and versioning coming in, we've started updating the source a lot more often than before. We should come up with a process to keep these docs in sync.

Some options:

  • Auto generate (most of) the docs reference
  • Keep manually updating the docs - would require some process (anything from calendar reminder to manually go over deltas to automated issue creation)
  • Deleting the duplication and referencing the source

bergundy avatar Sep 27 '22 17:09 bergundy

Looked into protoc-gen-doc for a minute. Ran the docker file on the examples to get a few markdown files.

Looks like you can create your own template too.

rachfop avatar Sep 27 '22 21:09 rachfop