[go: up one dir, main page]
Menu ▾ ▴

#166 Add an architecture page to the documentation

0.3
done
nobody
None
nobody
2019-09-07
2019-08-15
Ulf Lorenz
No
What and Why

Altogether, the documentation of Wavepacket should be pretty good. However, we currently have hands-on documentation (tutorial, highlighted demos), and a reference. What is missing a little is an architecture page that documents the main interfaces and how they play together.

Acceptance criteria
  • Add an architecture page to the Wiki or, preferably, the doxygen documentation, which describes the individual Wavepacket modules and how they work together.

added a basic architecture page to the doxygen documentation. Linked from the main page and all module pages.

Discussion

  • Ulf Lorenz

    Ulf Lorenz - 2019-09-02
    • status: open --> assigned
    • assigned_to: Ulf Lorenz
     

  • Ulf Lorenz

    Ulf Lorenz - 2019-09-07
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -5,3 +5,8 @@
 #####Acceptance criteria#####

 * Add an architecture page to the Wiki or, preferably, the doxygen documentation, which describes the individual Wavepacket modules and how they work together.
+
+
+----
+
+added a basic architecture page to the doxygen documentation. Linked from the main page and all module pages.
    • status: assigned --> done
    • assigned_to: Ulf Lorenz --> nobody
     

Log in to post a comment.