Merge pull request #49 from srajan-kiyotaka/sracho

added API Refference.

docs/Agent.md

@@ -11,3 +11,7 @@ The Agent module provides implementations for different types of agents that ope
 - **TreeAgent**: Represents an agent specifically designed to navigate and manipulate tree structures. For detailed information on the `TreeAgent` class and its methods, refer to [TreeAgent Documentation](./treeAgent.md).
 
 - **GraphAgent**: Represents an agent specialized in navigating and interacting with graph-based environments. For detailed information on the `GraphAgent` class and its methods, refer to [GraphAgent Documentation](graphAgent.md).
+
+---
+
+**Note**: For detailed documentation on each class, click on the respective links above.

docs/ReadMe.md

@@ -0,0 +1,17 @@
+# Documentation
+
+This folder contains documentation for various classes and components of the project.
+
+## Class Documentation
+
+### [World](World.md)
+
+- Documentation for the `World` class, explaining its attributes, methods, and functionality in managing the environment for agents.
+
+### [Agent](Agent.md)
+
+- Documentation for the `Agent` class, detailing its attributes, methods, and role in interacting with the world environment.
+
+### [DataStructures](DataStructures.md)
+
+- Here you can find documentation for various data structures used in the project, detailing their implementation and usage within different components.

docs/World.md

@@ -12,4 +12,19 @@ Returns the screen size for any operating system.
 - `NotImplementedError`: If the operating system is not supported.
 
 **Returns:**
-- `tuple`: A tuple containing the width and height of the screen.
+- `tuple`: A tuple containing the width and height of the screen.
+
+## Classes
+
+- [**CreateGridWorld**](./gridWorld.md):
+  - Represents a grid-based world environment. This class facilitates the creation, visualization, and manipulation of a grid structure where agents can navigate and interact with nodes.
+
+- [**CreateTreeWorld**](./treeWorld.md):
+  - Models a tree-based world environment. It supports operations such as node insertion, deletion, traversal, and visualization within a hierarchical tree structure.
+
+- [**CreateGraphWorld**](./graphWorld.md):
+  - Implements a graph-based world environment. This class allows for the creation, visualization, and management of nodes and edges in a graph structure. It supports operations like adding nodes, creating edges, and visualizing connectivity.
+
+---
+
+**Note**: For detailed documentation on each class, click on the respective links above.