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

Add specification for data schemas and/or AOEF format to reference in docs? #5

Open
NickleDave opened this issue Feb 16, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@NickleDave
Copy link

Hi @mbsantiago, good talking with you today.

As we discussed, I was thinking it might be helpful to add a more formal description of the soundevent schema to the docs, and maybe a schema for the Acoustic Objects Exchange format you mention here

The descriptions you have in the data schemas section and the user guide are very well written, intuitive, and helpful for understanding the package.

But adding a more formal description of the schema would be good as well, to:

  • help understand the mapping/hierarchy from pydantic classes to schema (e.g., not clear to me right now if Dataset is the top-level object that I should interact with "first"?)
  • open up a broader conversation in the bioacoustics community about what kind of schemas + standards we need so that file formats are more portable and tools are interoperable

If it were me I would put this more formal description in the "Reference" section of the docs, following the Diataxis framework (and maybe move the API docs to their own separate section "API" or a sub-section within "reference")?

Hope that feedback is helpful and that we can keep talking!

@mbsantiago mbsantiago self-assigned this May 14, 2024
@mbsantiago mbsantiago added documentation Improvements or additions to documentation help wanted Extra attention is needed labels May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants