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 for group events #338

Merged
merged 3 commits into from
Nov 2, 2022
Merged

Documentation for group events #338

merged 3 commits into from
Nov 2, 2022

Conversation

cookeac
Copy link
Collaborator

@cookeac cookeac commented Oct 20, 2022

Preview of documentation (much more to be done)

Preview of documentation (much more to be done)
- Explanation of animal sets and groups (resolves adewg#272)
- Start of ADE information model documentation (adewg#300)
@cookeac cookeac linked an issue Oct 20, 2022 that may be closed by this pull request
We discussed and agreed that manually replicating the properties in markdown might be easy to read but would be very hard to maintain.
Replace embedded links to previous markdown files with links direct to the JSON schema files (for those who have confidence to interpret JSON schema).

Not a long term solution.
@cookeac
Copy link
Collaborator Author

cookeac commented Oct 20, 2022

Simplified - just a few readme files and then the documentation of when to use animal sets and when to use group events.
The internal links in the latter document now point directly to the resource JSON schemas (rather than to manually maintained markdown or trying to deeplink into a open API schema viewer.

Copy link
Collaborator

@tpekeler tpekeler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New structure seems to be much better maintainable. Differences between Animal sets and Group events seems to be described clearly. Cannot verify the links embedded, since they are not opening correctly, needs to be confirmed, that links are correct after merging.

@cookeac cookeac merged commit f48f84a into adewg:Develop Nov 2, 2022
@cookeac cookeac deleted the group-docs branch March 9, 2023 01:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document semantics for Animal Sets - Groups
2 participants