Feedback for HTML

[lzehl]

First @olinux thanks for setting up the HTMLs for the documentation so quickly :slightly_smiling_face: I had now the time to go over the layout and wrote down some feedback:

• we should not capitalize the header (this is my personal view, feel free to object)
• the Name can be deleted from the table (I would focus here on what the people handle / see on the GitHubs and the Python Cli)
• we should change Property to property name
• we should change Description to property description
• we should change Instruction to value instruction or instruction for value
• we should change Content type(s) to expected value type (because the ContentType is a schema, and that will confuse people)
• if possible, we should add to the expected value type string the format (e.g., string (format: date))
• we should add a column for expected value number or expected value count with:
  • 0 - 1 for optional values with a single entry allowed
  • 1 for required values with a single entry allowed
  • 0 - n for optional values with multiple entries allowed
  • 1 - n for required values with multiple entries allowed
  • 0 - X for required values with X entries allowed
  • 1 - X for required values with X entries allowed
• if possible we should maybe additionally highlight required properties (e.g., making the property name bold)
• we should try to highlight the value types that are links to other schemas (e.g., making them bold or using a different color)
• we should change the line below the title to:
  • type: https://openminds.ebrains.eu/core/SCHEMANAME - view full JSON-Schema
• we should maybe change the column order to:
  • property name
  • property description
  • expected value type
  • expected value count
  • instruction for value
• we should modify a bit the footnote (if possible) to:
  • *This is the simplified property name - within a metadata instance of this schema (JSON-LD) the properties are extended to map to the openMINDS vocabulary namespace ("https://openminds.ebrains.eu/vocab/PROPERTY"). To learn more please go to: LINK to collab page with the JSON-LD docu

What do you think? Are these good ideas? Are they feasible?

[lzehl]

@olinux thanks for your help fixing this. I've found another small issue which I'll try on my own first, but may get back to you:

• display of array of "links" is not yet working

[lzehl]

I think that one we solved