Add link to docs from interface

Issue #305 closed
Ed McDonagh created an issue

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)

  1. Ed McDonagh reporter

    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>>

  2. Ed McDonagh 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?

  3. David Platten

    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.

  4. David Platten

    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?

  5. Ed McDonagh 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 Not sure I have the appetite for doing that this time around... do you?

    Otherwise we can add it as a future enhancement!

  6. Log in to comment