Add link to docs from interface
Issue #305
closed
Context specific where possible. Will need to add a note to self to change all links from latest to 0.7 before final release.
Comments (15)
-
reporter
-
reporter
Updated the other views pages with the version import and feeding the docs version to the template refs
#305→ <<cset 5b574fd078f5>>
-
reporter
Maybe the thing to do would be to have a generic link to the docs on every page, then if there are specific docs, convert the link to a dropdown menu with generic and one or more specific links. What do you reckon @dplatten?
-
reporter
More complex code required on each template now, but better I think to have both generic and specific available. Refs
#305→ <<cset ceb51fcfddd6>>
-
Having a dropdown menu to specific documents sounds good. I'll take a look at what you've done either later on today or at some point tomorrow.
-
The dropdown that you've done is great.
-
reporter
Changed so that the dropdown is in the base template, with any specific docs being added to the individual templates. Refs
#305→ <<cset 705ee973170b>>
-
A thought just crossed my mind: it's possible that some OpenREM users will install the system on an internal network which has no internet access. The document links won't work for them. @edmcdonagh, do you think this is likely / matters?
-
reporter
I went through that thought process too. I know there are users where the server doesn't have internet access, because they've had terrible trouble installing from pip etc.
However, even when the server has no internet access, the user might on the PC they are accessing it from.
But that will still leave people who are on networks that are very locked down.
The solution to this would be for an option to download from RTD and install the docs on the server, then allowing a configuration of where they are. Probably in local_settings.py. Not sure I have the appetite for doing that this time around... do you?
Otherwise we can add it as a future enhancement!
-
That sounds fine to me. Let's add the local docs as a future enhancement.
-
reporter
Added docs to the filtered base template and home. Refs
#305→ <<cset 42a9fdc0f578>>
-
Added document links for the display name pages. References issue
#305.→ <<cset 20076745b582>>
-
reporter
Move command line import of patient size data to the web version doc for the same. Added link to docs from size upload template, refs
#305→ <<cset 9a8e1198b53f>>
-
reporter
Minor changes to release notes. Added specific docs links to three templates. Refs
#305→ <<cset 9c43a93ac5b8>>
-
reporter
- changed status to closed
Added more links to the documentation, updated changes and release notes. I think this should probably close
#305→ <<cset 8eb1fffb7264>>
- Log in to comment
Added link to help docs at the right hand end of the nav bar. Opens in new tab. Block to override page for specific docs. Currently no indication of whether link is generic or specific. Refs
#305→ <<cset 2a74246abd94>>