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

Data model documentation refinements #68

Closed
Bankso opened this issue Feb 5, 2024 · 1 comment · Fixed by #91
Closed

Data model documentation refinements #68

Bankso opened this issue Feb 5, 2024 · 1 comment · Fixed by #91
Assignees
Labels
documentation Improvements or additions to documentation effort-mid priority-high

Comments

@Bankso
Copy link
Contributor

Bankso commented Feb 5, 2024

Following #49, #66 and in addition to #67

Initial deployment here: https://mc2-center.github.io/data-models/

Ideas for changes/additions to the data model documentation (in no particular order):

  1. for any component or valid value table, include the type and description alongside the table name.
    • General form example:
      • type: name
        • description
    • Specific example:
      • Attribute: Dataset Assay
        • the experimental assay associated with the content in the dataset
  2. add a template/model table that shows the component/data type, description of the component, and link to the component attribute table
  3. in attribute tables, add a link to the valid values associated with each attribute
  4. show the template/component directory on the home page and move the term dictionary to the second header tab
  5. modify the term dictionary to display the following:
    • Components (or Data Types, Data Models?) --> link to table listing all components
      • list component names and links to attribute tables
    • Attributes --> link to table listing all attributes
      • list attribute names, which link to row in attribute table
    • Valid Values --> link to tables listing all valid values by type
      • list valid value types in alphabetical order, linking to table associated with type
@vpchung vpchung added the documentation Improvements or additions to documentation label Feb 6, 2024
@vpchung
Copy link
Member

vpchung commented Mar 11, 2024

3/11/24 update

PR is ready for review ✨

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 effort-mid priority-high
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants