Opened 7 years ago

Closed 7 years ago

#436 closed enhancement (fixed)

Restructure top level of documentation window in application

Reported by: butler Owned by: butler
Priority: minor Milestone: SasView 4.0.0
Component: SasView Keywords:
Cc: Work Package: SasView Documentation

Description (last modified by butler)

As noted by Richard Heenand during the SasView 3.1 release testing phase as well as others, the top level tree gives user and developer documentation requiring the user to click twice to get to appropriate documentation. Further model documentation which is really user documentation and is approriately placed under user documentation, is inexpicably duplicated at the top level on a par with developer and user documentation.

To Do:

  • Need to remove the top level call to model documentation.
  • Should make top level documentation the user documentation so users don't have to click twice
  • Decide what to do about developer docs. Richard suggests putting them under user docs but this seems a bit obfuscational as it is NOT a user documentation. It is still available from the command line and can be raised with a browser by appropriate call to top level index. Further suggest we start pushing the docs build to the website so is available with loading SasView. Here the index would be the top level and have both user and developer docs as links.

Change History (5)

comment:1 Changed 7 years ago by butler

  • Description modified (diff)

comment:2 Changed 7 years ago by butler

  • Owner set to butler
  • Status changed from new to assigned

comment:3 Changed 7 years ago by butler

Ok - so actually easier than I thought. Have dealt with first two issues. Moreover even in SasView GUI from user docs you can click backward in toctree to top level and thence to developer docs. will leave this open for next release as a discussion: Do we want to make docs push to webpage?

comment:4 Changed 7 years ago by butler

  • Milestone changed from SasView Next Release +1 to SasView 4.0.0

comment:5 Changed 7 years ago by butler

  • Resolution set to fixed
  • Status changed from assigned to closed

I think this ticket should be closed. The issue of auto pushing the latest release docs to webpage should be a separate ticket though it is now part of the documented release process. Any new issues should generate a new ticket.

Note: See TracTickets for help on using tickets.