minor docs fixes

Signed-off-by: Bruno Bernard <[email protected]>
opensourcerouting · Aug 28, 2023 · 4ddc5cb · 4ddc5cb
1 parent 0e719aa
commit 4ddc5cb
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 2 deletions.
diff --git a/docs/anatomy/assets/anatomy.svg b/docs/anatomy/assets/anatomy.svg
diff --git a/docs/anatomy/overview.mdx b/docs/anatomy/overview.mdx
@@ -2,6 +2,9 @@
 
 Tests in the topotato framework are structured into different sections that collectively define the test's behavior, topology, and configurations. This document provides an overview of these sections and their components.
 
+<Image src="/anatomy/assets/anatomy.svg" caption="Topotato structure" />
+
+
 
 ### Header
 
@@ -37,6 +40,8 @@ __topotests_rev__ = 'a770da1b1c6290f53cc69218a30360accd6a0068'
 
 These markers provide information about the topotato version, the test file, and the revision, aiding in managing compatibility and version control.
 
+</hr>
+
 ### Topology Definition
 
 In topotato, a test topology is defined using ASCII diagrams enclosed within a function marked with the `topology_fixture` decorator. Here's an example of defining a topology named `topo1`:
@@ -54,11 +59,13 @@ The ASCII diagram visually represents the topology. The function's name `topo1`
 
 <Info>But if complexity grows, it might be better to split the tests into separate files.</Info>
 
+</hr>
+
 ### FRR Configurations
 
-Topotato generates FRR configurations using [jinja2](https://palletsprojects.com/p/jinja/) templates embedded within the test script. Configuration templates define various aspects of router behavior. Here's an example of defining FRR configurations:
+Topotato generates FRR configurations using [Jinja2](https://palletsprojects.com/p/jinja/) templates embedded within the test script. Configuration templates define various aspects of router behavior. Here's an example of defining FRR configurations:
 
-<Warning>Jinja2 template used has been customized a little bit.</Warning>
+<Warning>This Jinja2 template used has been customzied. See [`frr configuration section`](/anatomy/frr-config)</Warning>
 
 ```python
 class Configs(FRRConfigs):
@@ -83,6 +90,8 @@ These configurations can reference dynamic variables, making them more maintaina
 
 Each *daemon* can be configured for each routers by using their respective name and configuration. 
 
+</hr>
+
 ### Test Classes
 
 All topotato tests are organized within classes that inherit from the `TestBase` class. The class definition binds together the test content, topology, and configurations. Here's an example: