Documentation #1360

Feature #861: === Website & Examples ===

reequilibrate hierarchy levels in online docs

Added by wuttke over 3 years ago. Updated over 1 year ago.

Status:ResolvedStart date:03 Mar 2016
Priority:NormalDue date:
Assignee:pospelov% Done:

0%

Category:-
Target version:Sprint 37

Description

Current structure of online docs is:

    Welcome to BornAgain
    Functionality overview
    Architectural overview
    Installation instructions
    Working with BornAgain
        Using Graphical User Interface
            Quick Start
            BornAgain GUI overview
       Working with Python scripts
    Examples of BornAgain usage
    API References
    Troubleshooting
    Frequently Asked Questions

We shall reorganize them as
    Introduction
        Welcome to BornAgain
        Functionality overview
        Architectural overview
    Getting started 
        Installation instructions
        Quick start # moved here from GUI section
        Troubleshooting # moved here from top level
    Running the Graphical User Interface
    Working with Python scripts
         ...
         Fitting examples # moved here from Examples section 
    Sample model reference # Reference or Examples, depending on whether we aim at completeness
    API Reference
    Frequently Asked Questions

Rationale: Less entries at top-level, more standard titles ("introduction", "getting started"), less hierarchical levels for the core sections (GUI usage, Python usage moved to top level).

History

#1 Updated by wuttke over 3 years ago

  • Description updated (diff)

#2 Updated by wuttke over 3 years ago

  • Description updated (diff)

#3 Updated by wuttke over 3 years ago

  • Parent task set to #861

#4 Updated by wuttke over 3 years ago

  • Description updated (diff)

no objections raised, so we go for it

#5 Updated by pospelov over 1 year ago

  • Status changed from New to Sprint
  • Target version set to Sprint 36

#6 Updated by pospelov over 1 year ago

  • Target version changed from Sprint 36 to Sprint 37

#7 Updated by pospelov over 1 year ago

  • Assignee set to pospelov

#8 Updated by pospelov over 1 year ago

  • Status changed from Sprint to Resolved

Also available in: Atom PDF