search

GenomicsStandardsConsortium / mixs6.2_release_candidate

Code repo for converting MIxS 6.1 XLSX to MIxS 6.2 YAML
https://genomicsstandardsconsortium.github.io/mixs6.2_release_candidate/
MIT License
0 stars 0 forks source link

Autogenerated web documentation should include a minimal table of all terms on it's own page #4

Closed turbomam closed 1 year ago

jjkoehorst commented 1 year ago

This would be highly appreciated and it does not have to be overly complex or extensive. A simple table with ID, label and description might be sufficient.

Most people use for example only the generic package but they might have additional metadata that has been used in other well defined packages. To have such a general overview in which they can apply basic CTRL+F methods could be very useful.

turbomam commented 1 year ago

@jjkoehorst can you elaborate on the "generic package"? That isn't anything that is defined in this schema.

turbomam commented 1 year ago

I agree that this will be useful and can easily be implemented, but only as a new, extremely large section on the schema's landing page

The challenge will be building it on another page and providing a link on either the right (section-oriented) menu or the left (open-ended) menu

jjkoehorst commented 1 year ago

I am mostly familiar with the ENA submission procedures https://www.ebi.ac.uk/ena/browser/view/ERC000011 for which only date and location is obligatory and used in a lot of cases

turbomam commented 1 year ago

Move types section to separate page

also rename some of the sections

turbomam commented 1 year ago

sort elements in tables alphabetically

packages -> externsions

turbomam commented 1 year ago

@sujaypatil96

turbomam commented 1 year ago

emphasize usability to a wide audience over comprehensiveness

turbomam commented 1 year ago

Where/how will all of the documentation from this repo be integrated with the GSC website?

ramonawalls commented 1 year ago

The terms page should be separate from the page that lists all the classes, since it is such a long list. It should include at least the term label, ID, and definition (linkml description).

only1chunts commented 1 year ago

The terms are listed on the gensc.org website at present: https://www.gensc.org/pages/standards/all-terms.html I would appreciate a way to have that table auto-generated from any new MiXS releases. Currently it relies on a json format file of the terms being included in the website repo when the website is built, but I'm good with any alternatives that results in a similar functionality.