Ichthyostega
8e250839f4
During the last months, a lot of gradual changes to policies and guidelines had been finalised and documented. Moreover, recent clarifications regarding memory management in the render engine will lead to a clearer definition of the »Vault« Layer's role, with some ''engine code'' expected to move down. On this occasion, I reworked relevant sections in the documentation to confirm the role that now falls to central parts of the overall architecture. Notably I decided to rename those parts related to the application backbone as »Vessel« — to underpin the more active and defining role they assumed.
125 lines
5.4 KiB
Text
125 lines
5.4 KiB
Text
Documentation
|
|
=============
|
|
|
|
This documentation section contains documentation for users and developers alike.
|
|
|
|
== User ==
|
|
|
|
As a start, you should visit the introductory text
|
|
link:user/intro/intro.html[Lumiera (as seen) from Outer Space]
|
|
|
|
A user manual containing the full reference for using Lumiera is planned:
|
|
|
|
* link:user/manual.html[User Manual] _(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 documentation to assist you in navigating through the documents.
|
|
|
|
=== Developer Documentation is Arranged into Layers
|
|
|
|
image:devel/images/doc_map.png[Map]
|
|
|
|
The various pieces of documentation are not scattered about randomly. These are arranged and organised along
|
|
established simple yet flexible guidelines to enable easy and intuitive access. It is not rigid and conformity
|
|
is not required. There may be very good reasons to adapt the rules with some degree of flexibility at times;
|
|
and sometimes it might be difficult to select a unique section in which to place new documents.
|
|
|
|
The various documents are organised in an hierarchical structure of layers. The uppermost layer, or root, is
|
|
the point of entry into the Lumiera developer documentation universe. The lowest layers are populated by the
|
|
Lumiera API documentation which is currently produced from the source code using Doxygen.
|
|
|
|
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.
|
|
--
|
|
|
|
--
|
|
|
|
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
|
|
page. This menu is also organised into layers that reflects the organisation of
|
|
the documentation to help you navigate through the documentation.
|
|
|
|
Source code doc directory structure ::
|
|
The layout of the sub-directories below the *doc* directory is structured around
|
|
the hierarchy,
|
|
|
|
==== The Uppermost Layer
|
|
|
|
At the highest, uppermost layer is the document
|
|
link: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 on which
|
|
router to pursue: documentation with a heavy code based leaning; or more descriptive
|
|
documentation on the design of Lumiera, which omits most technical details of the implementation.
|
|
Consequently, the documentation is divided into two main parts:
|
|
|
|
* link:design/index.html[Lumiera Developer Design Documents]
|
|
* link:technical/index.html[Lumiera Developer Technical Documents]
|
|
|
|
--
|
|
|
|
--
|
|
|
|
|
|
===== Design Documentation
|
|
|
|
[width="90%",frame="topbot",options="header",cols="^,2<"]
|
|
|================================================================================================
|
|
|Section|Remarks
|
|
|link:design/architecture/[Architecture]|Structure of Lumiera
|
|
|link:design/gui/[GUI]|The Lumiera ⟷ user interaction layer
|
|
|link:design/model/[Model]|Low-level and high-level models
|
|
|link:design/engine/[Engine]|Renderer, output generation, ...
|
|
|link:design/lowlevel/[Low-level]|Low-level and system services
|
|
|link:design/application/[Application]|Application framework
|
|
|link:design/extension/[Extension]|Dynamically loaded Extensions
|
|
|link:design/workflow/[Workflow]|Workflow and Interaction Design
|
|
|link:design/governance/[Governance]|Meta project concerns
|
|
|================================================================================================
|
|
|
|
|
|
|
|
===== Technical Documentation
|
|
|
|
[width="90%",frame="topbot",options="header",cols="^,2<"]
|
|
|================================================================================================
|
|
|Section|Remarks
|
|
|link:technical/build/[Build System]|Build, Packaging and CI
|
|
|link:technical/stage/[Stage]|GUI (technical aspects)
|
|
|link:technical/steam/[Steam]|Session and processing coordination
|
|
|link:technical/vault/[Vault]|Low-level operations
|
|
|link:technical/library/[Library]|Utilities and custom frameworks
|
|
|link:technical/code/[Code base]|Code management, organisation, ...
|
|
|link:technical/infra/[Infrastructure]|Website and developer tooling ...
|
|
|link:technical/howto/[Developer HowTos]|Instructions and guides for developers
|
|
|link:/doxy/[API Doc]|Using https://www.doxygen.nl/[Doxygen] to generate doc from code
|
|
|================================================================================================
|
|
|
|
|
|
The TiddlyWiki::
|
|
Currently, Lumiera is still in the design- and evolution phase.
|
|
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.
|
|
|
|
-> access the Development link:/wiki/renderengine.html[TiddlyWiki online here]
|
|
|
|
|
|
== Media and Presentations ==
|
|
|
|
This section holds documents and materials used to present and promote Lumiera,
|
|
articles, summaries and whitepapers
|
|
-> link:/media/[Index]
|
|
|
|
|