Skip to content

Unhelpful docs #539

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

Open
ibevers opened this issue Nov 27, 2024 · 1 comment
Open

Unhelpful docs #539

ibevers opened this issue Nov 27, 2024 · 1 comment

Comments

@ibevers
Copy link

ibevers commented Nov 27, 2024

I find the documentation for ReproSchema very unintuitive. I’m not sure if it just doesn’t have the information I need or if I’m reading it wrong. For example, I wanted to know what types are valid for inputType while I’m creating an item, so I went here:
https://www.repronim.org/reproschema/schema/doc-linkml-autogen/inputType/

However, this doesn’t show me what options there are when constructing a new item (string, int, etc). How can I find this information without having to ask someone?

I feel like the docs should tell you what entries are valid so you can easily and confidently construct items based on the documentation. The current documentation is next to useless for that purpose.

@shnizzedy
Copy link
Collaborator

The inputTypes that the UI is equipped to handle are listed in the UI's README, but I think the type is truly a freeform string to allow for custom interfaces that use types not handled by the reproschema-ui

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

2 participants