nmfs-ost/ss3-doc

Navigation bar in html is ambiguous

kellijohnson-NOAA opened this issue · 1 comments

https://github.com/nmfs-stock-synthesis/doc/blob/2382edf75594df93e7c50c17d677029be6a0bb5e/html_usermanual_snippets.html#L3-L6

The rendered html looks like
image
and it is unclear to me where the "buttons" actually lead to. What is "SS3 index"; which source code, i.e., the source code for SS3 or the source code for the manual; report an issue regarding the manual or report an issue about SS3. I think that the text could be made more clear as to where users are going when they click on the links. I suggest

  • Manual home page
  • :octocat: nmfs-stock-synthesis/doc
  • Manual issues
  • Table of contents

The current link to "Report and issue with the manual" does not actually take you to the issue reporter it takes you to the list of current issues. I am not sure which location is better but it seems as written it should go to https://github.com/nmfs-stock-synthesis/doc/issues/new rather than the issue list.

Nav bar is updated. See here