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

Provide a way of searching for usages of a LinkML construct #2092

Open
cmungall opened this issue May 2, 2024 · 0 comments
Open

Provide a way of searching for usages of a LinkML construct #2092

cmungall opened this issue May 2, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@cmungall
Copy link
Member

cmungall commented May 2, 2024

Currently users have a few different ways of getting examples of usages of LinkML constructs.

The best place to start is the main documentation. However, space limitations mean that we prefer to show a limited number of examples so as not to overwhelm (but we likely could show a lot more!)

The URI of the element also leads to the main rendered docs, but this is currently short on examples..

We should make it easier to find usages:

  1. Leverage the LinkML-registry to search schemas in the wild to see usages
  2. Have docgen inline the examples folder that is a defacto standard (including for the metamodel itself)
  3. The LinkML compliance tests have exhaustive (if a little concise) combinatorial examples, together with how they translate - we are currently working on making this output more transparent
@nlharris nlharris added documentation Improvements or additions to documentation enhancement New feature or request labels May 2, 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 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants