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

Taxonomy documentation needs clearer, stronger examples #36

Open
3 tasks
nimbinatus opened this issue Jan 6, 2025 · 1 comment · May be fixed by #37
Open
3 tasks

Taxonomy documentation needs clearer, stronger examples #36

nimbinatus opened this issue Jan 6, 2025 · 1 comment · May be fixed by #37
Assignees

Comments

@nimbinatus
Copy link
Member

We need stronger documentation around writing strong taxonomy submissions, especially around the seed_examples block. In particular:

  • The documentation needs to provide broken-out examples for each field.
  • The documentation needs to explain what the context information is used for and include strong examples.
  • The documentation needs to have examples for strong questions and answers that also demonstrate that the values are not used directly in the model.
@nimbinatus
Copy link
Member Author

I'll be picking this up starting today.

@nimbinatus nimbinatus self-assigned this Jan 6, 2025
@nimbinatus nimbinatus linked a pull request Jan 6, 2025 that will close this issue
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

Successfully merging a pull request may close this issue.

1 participant