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

Need better documentation (with more examples) to explain LinkML to new users #2043

Open
mszulcz-mitre opened this issue Apr 1, 2024 · 1 comment
Labels
community-generated documentation Improvements or additions to documentation enhancement New feature or request

Comments

@mszulcz-mitre
Copy link

Is your feature request related to a problem? Please describe.
I'd like to use LinkML but I don't understand all its features.

Describe the solution you'd like
I'd like expanded documentation with examples. Currently, the following keywords and concepts are not clear to me:

  • domain
  • rank
  • is_subset
  • emit_prefixes
  • predicate slots (mentioned here)
  • logical characteristics: transitive, symmetric, antisymmetric, reflexive, locally_reflexive

I've read the available documentation and reviewed examples, but I don't understand why theses concepts and keywords are useful or when to use them.

How important is this feature? Select from the options below:
• Medium - can do work without it; but it's important (e.g. to save time or for convenience)

When will use cases depending on this become relevant?
• Short-term - 2-4 weeks

Additional context
I like LinkML but I've been struggling to understand how to use it for a while. Expanded documentation with more examples would probably help gain users.

cmungall added a commit that referenced this issue Apr 1, 2024
Remove translator terminology. See #2043
@nlharris nlharris changed the title Expanded documentation Need better documentation (with more examples) to explain LinkML to new users Apr 1, 2024
@nlharris nlharris added documentation Improvements or additions to documentation enhancement New feature or request community-generated labels Apr 1, 2024
@nlharris
Copy link
Contributor

nlharris commented Apr 1, 2024

Hi @mszulcz-mitre, thanks for your interest in LinkML, and thanks for filing this issue. We are aware that the documentation has room for improvement, and we agree with you that adding examples would be helpful. We currently have very limited person-time to work on LinkML but are hoping that will improve in the near future!

In the meantime, we encourage you to join our LinkML community channel and ask specific questions there (though "Explain LinkML to me" may not get you what you're hoping for 🙂)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community-generated documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants