Better API reference

ondrej-lukas · ondrej-lukas · commit f3140cc7633d · 2025-07-01T17:54:02.000+02:00
diff --git a/NetSecGameAgents b/NetSecGameAgents
@@ -1 +1 @@
-Subproject commit 3a46c12d64334303210cdf6b373177febe642079
+Subproject commit 6c27fa4d84bee0841b90a728fd86d996a2d17c88
diff --git a/docs/game_components.md b/docs/game_components.md
@@ -1,3 +1,2 @@
 # Game Components
-Game components are the building blocks of the Network Security Game.
 ::: AIDojoCoordinator.game_components
diff --git a/docs/game_coordinator.md b/docs/game_coordinator.md
@@ -2,6 +2,7 @@
 Coordinator is the centerpiece of the game orchestration. It provides an interface between the agents and the worlds.
 
 In detail it handles:
+
 1. World initialiazation
 2. Registration of new agents in the game
 3. Agent-World communication (message verification and forwarding)
diff --git a/docs/index.md b/docs/index.md
@@ -136,9 +136,10 @@ The NetSecGame environment has several components in the following files:
 |		├── actions_parser.py
 ```
 Some compoments are described in detail in following sections:
+
 - [Architecture](architecture.md) describes the architecture and important design decisions of the NetSecGame
-- [Configuration](configuration.md) 
-- [API Reference](reference.md)
+- [Configuration](configuration.md) describes the task and scenario configuration for NetSecGame
+- [API Reference](game_components.md) provides details of the API
 
 ## About
 This code was developed at the [Stratosphere Laboratory at the Czech Technical University in Prague](https://www.stratosphereips.org/). The project is supported by Strategic Support for the Development of Security Research in the Czech Republic 2019–2025 (IMPAKT 1) program, by the Ministry of the Interior of the Czech Republic under No.

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,2 @@`
`1`	`1`	`# Game Components`
`2`		`-Game components are the building blocks of the Network Security Game.`
`3`	`2`	`::: AIDojoCoordinator.game_components`