clingen-data-model / clingen-interpretation

Allele (variant) interpretation model and API for ClinGen
3 stars 1 forks source link

Better formatting on content sidebar #181

Closed cbizon closed 6 years ago

cbizon commented 6 years ago

I've added a bunch of discussion pages, but now the sidebar is kind of hard to read:

There are 5 discussion topics. Each has a multiword title, and the breaks that get put in make it hard to read (see image)

image

I'm not sure whether we want to have another tag with a shorter name for the sidebar, or just have short titles, or some kind of bullet, or spacing, or what. I defer to people with design sense/skill.

larrybabb commented 6 years ago

Yes, I've run into this too. I think we definitely want to manage the menu sidebar titles to allow for shorter (thumbnail) versions of the actual titles on the pages. I can work with you @sgoehringer to get this sorted out

bpow commented 6 years ago

Not sure if there is a better issue to discuss this, but we keep moving around the organization of the menus and I don't know that anyone is ever happy with it...

Right now, we have:

I'm not really fond of having the extra level to get to the entity definitions that happens by having the "Technical Reference" section (which also incorporates the JSON schema right now). I think JSON schema itself could go to a top-level (or maybe in an "Information Artifacts" section or something with a better name that could also include the json-ld context, link to relevant owl files).

We've stuck with these ideas of "User Guide" and "Technical Reference", and had many discussions about for what audience they are each intended...

Howzabout we just title them more by what they do?

User Guide => Understanding the model Technical Reference => Entity Definitions

Rather than discuss this again on a call, I think it would be helpful to have some people put some thoughts in writing (like in #185 ) to focus the discussion.

larrybabb commented 6 years ago

done during recent re-org of site. more to come when we fully consolidate modeling sites under one project.