DOC: review and minor layout tweaks
This commit is contained in:
parent
620430640b
commit
4524145420
1 changed files with 29 additions and 23 deletions
|
|
@ -15,7 +15,7 @@ A user manual containing the full reference for using Lumiera is planned:
|
|||
== Developer ==
|
||||
|
||||
This section is a guide on how the developer documentation is arranged, organised and grouped. We present here
|
||||
a map of the developer documention to assist you in navigating through the documents.
|
||||
a map of the developer documentation to assist you in navigating through the documents.
|
||||
|
||||
=== Developer Documentation is Arranged into Layers
|
||||
|
||||
|
|
@ -33,8 +33,11 @@ Lumiera API documentation which is currently produced from the source code using
|
|||
The map is depicted above in the illustration. Below we provide links to the top-level documents to all
|
||||
elements in the map froom which you can launch deeper into the lower layers of the documentation. We present
|
||||
these in tabular form to ease navigation.
|
||||
--
|
||||
|
||||
--
|
||||
|
||||
==== Documentation Layer Structure Appears at Various Places in The Project
|
||||
The *Documentation Layer Structure* appears at various places in the project...
|
||||
|
||||
Lumiera homepage ::
|
||||
https://Lumiera.org[Lumiera homepage] by the menus on the left hand-side of the
|
||||
|
|
@ -48,14 +51,14 @@ the hierarchy,
|
|||
==== The Uppermost Layer
|
||||
|
||||
At the highest, uppermost layer is the document
|
||||
https://lumiera.org/documentation/user/intro/intro.html[Lumiera (as seen) from Outter Space]. This is the node
|
||||
https://lumiera.org/documentation/user/intro/intro.html[Lumiera (as seen) from Outer Space]. This is the node
|
||||
on the left in the illustration above. All new to Lumiera should read this document. You can always return
|
||||
to this document later if you are entirely lost and wish to find your bearings before navigating into the
|
||||
deeper documentation dungeons.
|
||||
|
||||
==== The Second Layer
|
||||
|
||||
At the second layer, the reader must make the first major decision oon which
|
||||
At the second layer, the reader must make the first major decision on which
|
||||
router to pursue: documentation with a heavy code based leaning; or more descriptive
|
||||
documentation on the design of Lumiera which avoids a code narrative. This
|
||||
section has two main sections:
|
||||
|
|
@ -63,47 +66,50 @@ section has two main sections:
|
|||
* link:design/index.html[Lumiera Developer Design Documents]
|
||||
* link:technical/index.html[Lumiera Developer Technical Documents]
|
||||
|
||||
--
|
||||
|
||||
--
|
||||
|
||||
===== Design Documents
|
||||
|
||||
.Developer Design Documentation
|
||||
[width="40%",frame="topbot",options="header"]
|
||||
===== Design Documentation
|
||||
|
||||
[width="90%",frame="topbot",options="header",cols="^,2<"]
|
||||
|================================================================================================
|
||||
|Sub-System and top-level entry |Remarks
|
||||
|Sub-System|Remarks
|
||||
|https://lumiera.org/documentation/design/architecture/index.html[Architecture]|Structure of Lumiera
|
||||
|https://lumiera.org/documentation/design/gui/index.html[GUI]|The Lumiera ⟷ user interaction layer
|
||||
|https://lumiera.org/documentation/design/model/index.html[Model]|Low-level and high-level models
|
||||
|https://lumiera.org/documentation/design/gui/index.html[GUI]|The Lumiera-user interaction layer
|
||||
|https://lumiera.org/documentation/design/plugins/index.html[Plugins]|External tools to provide functionality
|
||||
|https://lumiera.org/documentation/design/lowlevel/index.html[Low-level Model]|Render nodes
|
||||
|https://lumiera.org/documentation/design/engine/index.html[Engine]|Renderer, output generation, ...
|
||||
|https://lumiera.org/documentation/design/workflow/index.html[Workflow]|
|
||||
|https://lumiera.org/documentation/design/lowlevel/index.html[Low-level]|Low-level and system services
|
||||
|https://lumiera.org/documentation/design/application/index.html[Application]|Application framework
|
||||
|https://lumiera.org/documentation/design/plugins/index.html[Plugins]|Dynamically loaded Extensions
|
||||
|https://lumiera.org/documentation/design/workflow/index.html[Workflow]|Workflow and Interaction Design
|
||||
|https://lumiera.org/documentation/design/governance/index.html[Governance]|Meta project concerns
|
||||
|================================================================================================
|
||||
|
||||
|
||||
|
||||
===== Technical Documents
|
||||
===== Technical Documentation
|
||||
|
||||
.Developer Technical Documentation
|
||||
[width="40%",frame="topbot",options="header"]
|
||||
[width="90%",frame="topbot",options="header",cols="^,2<"]
|
||||
|================================================================================================
|
||||
|Sub-System top-level entry |Remarks
|
||||
|https://lumiera.org/documentation/technical/build/index.html[Build System]|Using SCons
|
||||
|https://lumiera.org/documentation/technical/stage/index.html[Stage] |GUI
|
||||
|https://lumiera.org/documentation/technical/steam/index.html[Steam]|Using (TiddlyWiki)
|
||||
|Sub-System|Remarks
|
||||
|https://lumiera.org/documentation/technical/build/index.html[Build System]|Build, Packaging and CI
|
||||
|https://lumiera.org/documentation/technical/stage/index.html[Stage]|GUI (technical aspects)
|
||||
|https://lumiera.org/documentation/technical/steam/index.html[Steam]|Session and processing coordination
|
||||
|https://lumiera.org/documentation/technical/vault/index.html[Vault]|Low-level operations
|
||||
|https://lumiera.org/documentation/technical/library/index.html[Support lib]|Interface and support libraries
|
||||
|https://lumiera.org/documentation/technical/code/index.html[Code base]|Code management, organisation, ...
|
||||
|https://lumiera.org/documentation/technical/infra/index.html[Infrastructure]|Code admin, checks, ...
|
||||
|https://lumiera.org/documentation/technical/howto/index.html[Developer HowTos]|Various developer HowTos
|
||||
|https://lumiera.org/documentation/technical/infra/index.html[Infrastructure]|Website and developer tooling ...
|
||||
|https://lumiera.org/documentation/technical/howto/index.html[Developer HowTos]|Instructions and guides for developers
|
||||
|link:/doxy/index.html[API Doc]|Using link:http://doxygen.org[Doxygen] to generate doc from code
|
||||
|================================================================================================
|
||||
|
||||
|
||||
The TiddlyWiki::
|
||||
Currently, Lumiera is still in the design- and evolution phase.
|
||||
There is an embedded JavaScript wiki (TiddlyWiki) within the source tree, mostly
|
||||
used as design notebook, featuring day-to-day design sketches, notes but also
|
||||
There is an embedded JavaScript wiki (https://classic.tiddlywiki.com/[TiddlyWiki]) within the source tree,
|
||||
mostly used as design notebook, featuring day-to-day design sketches, notes but also
|
||||
quite some more persistent planning. Finished documentation text is constantly
|
||||
moved over to the documentation section(s) of the Lumiera website.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue