Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation of messages and how they should be used (overview) #394

Open
cookeac opened this issue Jun 1, 2023 · 1 comment
Open

Documentation of messages and how they should be used (overview) #394

cookeac opened this issue Jun 1, 2023 · 1 comment

Comments

@cookeac
Copy link
Collaborator

cookeac commented Jun 1, 2023

We noted that some brief documentation of how to use each of the messages would be helpful. This is not a list of individual fields which should be autogenerated so that it is maintained.

@cookeac
Copy link
Collaborator Author

cookeac commented Jul 13, 2023

Steps:

  1. Define a structure for how we will document each message (how it should be used, and things that don't fit in a single line description)
  2. List the messages and split these between us for writing.

Target is people implementing but not developers (e.g. designers, animal recording specialists, etc)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant