Opened 5 years ago

Closed 4 years ago

#422 closed task (fixed)

Enhance help (non model) documentation

Reported by: smk78 Owned by: smk78
Priority: critical Milestone: SasView 4.1.0
Component: SasView Keywords:
Cc: Work Package: SasView Documentation

Description (last modified by butler)

The Sphinx help docs for Release 3.1 represent a porting of the pre-
existing HTML help docs to ReSTructured text.

Some restructuring has been conducted. Some (obvious!) equation errors
have been corrected. Some 'missing' content has been added.

The next steps are:

  • checking that the documentation actually reflects the current functionality of the program!
  • updating existing screenshots to match the current functionality of the program
  • adding additional screenshots

NOTE: Model documentation review is addressed separately in Ticket #19.

Change History (10)

comment:1 Changed 5 years ago by smk78

Also consider, as suggested by Richard, doing away with the 'top level' documentation menu. This would mean moving the links to the Model Functions and the Developer Documentation from Sphinx index.rst to the GUI Help dropdown and reorganising lower toctrees.

comment:2 Changed 5 years ago by smk78

Last suggestion dealt with under Ticket #436

comment:3 Changed 5 years ago by butler

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

comment:4 Changed 5 years ago by smk78

Need to add something about using Save Analysis and Save Project (suggestion ported from Ticket #20).

comment:5 Changed 5 years ago by smk78

Also see Ticket #33.

comment:6 Changed 4 years ago by butler

  • Description modified (diff)
  • Summary changed from Enhance help documentation to Enhance help (non model) documentation

comment:7 Changed 4 years ago by butler

  • Milestone changed from SasView 4.0.0 to SasView Next Release +1
  • Type changed from enhancement to task

While some work has been done, we still need an organized start to finish review which is clearly not going to be able to be done in time for release 4.0. Moving this to +1 but keeping the high priority on it.

comment:8 Changed 4 years ago by butler

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

comment:9 Changed 4 years ago by smk78

After discussions between PaulB & Steve we are closing this ticket as its original intention has now been served. A LOT of good work on the documentation has taken place since Code Camp III and it is now in a far better place than it was, but there will ALWAYS be room for improvement. If there are specific documentation issues/enhancements they should now be noted in specific tickets.

comment:10 Changed 4 years ago by smk78

  • Resolution set to fixed
  • Status changed from new to closed
Note: See TracTickets for help on using tickets.