Documentation #1360

Updated by wuttke over 3 years ago

Current structure of online docs is:
<pre>
Introduction
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
</pre>
I suggest to reorganize them as
<pre>
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 References
Frequently Asked Questions
</pre>
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).

Back