-
Notifications
You must be signed in to change notification settings - Fork 1
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
[Docs update] Restructuring the docs #43
Comments
Reviewing: |
To do:
Text accompanying tables to be updated from new JSON schema (tables updated automatically now)
add new examples from CA data / others with RDL Collection links (see #135 for list)
|
Add GLOSI to Exposure taxonomy list per #43
#120 updates the reference documentation (formerly known as the data model section). The schema tables are now generated from the schema as part of the Sphinx build so they will always be up-to-date and The diagrams, explanatory text and examples will need updating once the schema updates are done. |
From #120 (review):
|
Suggest to make longer tables (such as in codelists) collapsible, or other way to make the page more readable. |
@stufraser1 @matamadio building on the work in this issue and the proposed updates to the landing page in #170, I've been thinking about the structure and framing of the documentation and have the following proposal on which I would like your feedback. Implementing this is mostly a case of renaming/reorganising existing content, although there a couple of new pages to author. The objectives of the proposed updates to the structure and landing page content are: to clearly differentiate the concepts of metadata and risk datasets and to explain the role of RDLS in relation to those concepts; to provide a clear introduction to RDLS for new readers; and to provide make it easier for returning readers and implementers to find the information that they need. Structure
Landing page content
|
I think this is a lot clearer than the current landing page, From my perspective, please go ahead. @matamadio ? |
Yes, I like it. Please do. |
closing this as it's been addressed in #175 |
New documentation structure following the guidance in the ODS review.
SEE ONLINE PREVIEW
More in detail, navigation bar (sections) proposal:
The text was updated successfully, but these errors were encountered: