Closed vpchung closed 4 months ago
Note: I'm going to merge this PR in now, so that the docs site will build - that way, it will be easier for @aclayton555 to review and test.
Afterward, we can start ideating on what we want the final docs site to look like!
Thanks @vpchung (apologies, I didn't get a chance to take a look at this until now, but the screenshots above are looking great). This gives us a great base to start from. Just to confirm, is there a link I can navigate to in order to browse the docs?
I noticed the majority of the non-shared vocabulary terms do not have a Description - would it better to not display that column altogether rather than show the "nan" values?
Interesting. For many of these, I think it would be a straightforward and worthwhile tidy up to add descriptions. For example, for "CSBC" the description could simply be "The Cancer Systems Biology Consortium of the NIH/NCI Division of Cancer Biology." Perhaps we can approach this separate once we have the bigger picture of how many descriptions are not currently included
Oh no, not at all! I wanted to merge in the branch anyhow, so that you can more easily explore the docs site (otherwise, you would have to go through the technical steps of cloning this repo, installing python, etc).
The link is here: https://mc2-center.github.io/data-models/
Fixes #49
To test locally
Install mkdocs, mkdocs-material mkdocs-table-reader-plugin, ideally in a virtual environment, e.g.
Change directories to the repo and checkout this branch:
Start the server:
This will serve the documentation on http://127.0.0.1:8000.
Once done, stop the server with Ctrl + C
Preview
Home![Screenshot 2024-02-02 at 5 54 09 PM](https://github.com/mc2-center/data-models/assets/9377970/1adcc043-0281-4c1d-bba4-b3adf23fb93f)
Example of vocabulary page![Screenshot 2024-02-02 at 5 54 17 PM](https://github.com/mc2-center/data-models/assets/9377970/9104e208-87f2-4d45-9661-cafc21554172)
Example of template page![Screenshot 2024-02-02 at 5 54 24 PM](https://github.com/mc2-center/data-models/assets/9377970/35c1b3b9-bfa1-4278-826f-a3a696f204ff)
Example of another docs page![Screenshot 2024-02-02 at 5 54 32 PM](https://github.com/mc2-center/data-models/assets/9377970/00a7b666-a371-465d-b5a8-d655b39191a3)