Skip to content

Commit d68b6ea

Browse files
jaapiolinawolf
authored andcommitted
[DOCS] Add more details about flow
1 parent 51dd7d2 commit d68b6ea

File tree

3 files changed

+24
-2
lines changed

3 files changed

+24
-2
lines changed

docs/architecture.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,24 @@ all components.
2424
The ``guides``, ``guides-markdown`` and ``guides-restructuredtext`` are seen as the main
2525
libaries of the project. The other components are optional and can be used to extend the
2626
functionality of the main libraries for specific use cases.
27+
28+
Application flow
29+
================
30+
31+
Processing documents is done in a few steps.
32+
33+
#. :php:class:`Parsing <\phpDocumentor\Guides\Parser>` The first step is to parse the document. This is done by the :doc:`parser` component. The
34+
parser component will parse the document and create a tree of nodes. Each node
35+
represents a part of the document. For example a paragraph, a list or a table.
36+
#. :php:class:`Compiling <\phpDocumentor\Guides\Compiler\Compiler>` The second step is to compile the tree of nodes. This is done by the :doc:`compiler`
37+
component. During the compilation modifications can be made to the tree of nodes. For
38+
example the compiler can add a table of contents to the tree of nodes.
39+
40+
#. :php:class:`Rendering <\phpDocumentor\Guides\Renderer\BaseTypeRenderer>` The third step is to render the tree of nodes. This is done by the :doc:`render`
41+
component. The render component will render the tree of nodes to a specific output
42+
format. By default twig templates are used to render nodes to HTML. But you can
43+
create your own templates to render nodes to other formats. Or implement your own
44+
renderer to use a different template engine.
45+
46+
.. uml:: _uml/application-flow.puml
47+
:caption: Application flow

docs/developers/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,7 @@ application to render ReStructuredText or Markdown documents. Or want to integra
88
it in some other way that is not possible with the ``guides`` command line tool.
99

1010
.. toctree::
11+
:maxdepth: 1
12+
:titlesonly:
1113

1214
extensions/index

docs/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
.. include:: /include.rst.txt
22

3-
:project:
4-
Guides
53
:version:
64
dev-main
75

@@ -49,4 +47,5 @@ If you are looking for a complete solution to create a documentation website the
4947
developers/index
5048
architecture
5149
reference/index
50+
contributions/index
5251
about

0 commit comments

Comments
 (0)