Dev

.github/workflows/dev.yml

@@ -84,4 +84,4 @@ jobs:
           user: __token__
           password: ${{ secrets.TEST_PYPI_API_TOKEN }}
           repository-url: https://test.pypi.org/legacy/
-          skip-existing: true
+          skip-existing: true

.github/workflows/release.yml

@@ -29,12 +29,6 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
-      - name: build change log
-        id: build_changelog
-        uses: mikepenz/[email protected]
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
       - uses: actions/setup-python@v3
         with:
           python-version: ${{ matrix.python-versions }}

.gitignore

@@ -116,3 +116,5 @@ cython_debug/
 
 # Local Dev
 main.py
+
+tests/config.py

docs/Usage/installation.md

@@ -1,27 +1,79 @@
-## Organisation
+## Quick Installation Guide
 
-## Quick installation
+This guide provides instructions for installing `pydfirram` from various sources and using all plugins available in the `volatility3` repository.
 
 ### Prerequisites 
+
+Ensure you have the following installed:
+
 - Python
-- Poetry (for dev)
+- Poetry (for development)
 - pip
 
-### From source
-On a standard Linux distribution :
-```shell
-git clone https://github.com/pydfir/pydfirram
-poetry shell
-poetry install
-```
-### From pip stable
+### Installation Methods
+
+#### From Source
+
+To install `pydfirram` from the source on a standard Linux distribution, follow these steps:
+
+1. Clone the repository:
+    ```shell
+    git clone https://github.com/pydfir/pydfirram
+    ```
+
+2. Navigate into the project directory:
+    ```shell
+    cd pydfirram
+    ```
+
+3. Create a virtual environment and activate it using Poetry:
+    ```shell
+    poetry shell
+    ```
+
+4. Install the dependencies:
+    ```shell
+    poetry install
+    ```
+
+#### From pip (Stable)
+
+To install the stable version of `pydfirram` from pip, use the following command:
 
 ```shell
 pip install pydfirram
 ```
-### From pip dev
+
+#### From pip (Development)
+
+To install the development version of `pydfirram` from the TestPyPI repository, use the following command:
 
 ```bash
 pip install -i https://test.pypi.org/simple/ pydfirram
 ```
 
+#### Using All Plugins
+
+To use all plugins available in the `volatility3` repository, follow these steps:
+
+1. Install `pydfirram`:
+    ```bash
+    pip install pydfirram
+    ```
+
+2. Clone the `volatility3` repository:
+    ```bash
+    git clone https://github.com/volatilityfoundation/volatility3
+    ```
+
+3. Navigate into the `volatility3` directory:
+    ```bash
+    cd volatility3
+    ```
+
+4. Install the plugins:
+    ```bash
+    pip install .
+    ```
+
+This setup ensures that you have access to all the plugins provided by the `volatility3` repository.

docs/reference/reference.md

@@ -1,4 +1,31 @@
 <!-- This part of the project documentation focuses on
 an **information-oriented** approach. Use it as a
 reference for the technical implementation of the
-`calculator` project code. -->
+`calculator` project code. -->
+
+## Index of References
+
+This index provides a structured overview of the various reference documentation pages for the project, using the Diátaxis framework. Each page focuses on different components and functionalities of the project.
+
+### Documentation Pages
+
+#### [Base](base.md)
+This page details the foundational elements of the project. It includes core classes, functions, and their interactions.
+
+#### [Handler](handler.md)
+The handler documentation covers the management of different processes within the project. It outlines the implementation and usage of handlers in various scenarios.
+
+#### [Reference](reference.md)
+The reference page serves as a comprehensive guide to all modules, classes, and functions in the project. It is an exhaustive resource for understanding the project's API and architecture.
+
+#### [Renderer](renderer.md)
+This section explains the rendering process, detailing how data is transformed and presented. It includes examples and best practices for implementing renderers.
+
+#### [Test](test.md)
+The test documentation provides guidelines on how to write and run tests for the project. It includes details on testing frameworks, test coverage, and sample test cases.
+
+#### [Utils](utils.md)
+This page describes the utility functions and helper modules available in the project. It covers common patterns and reusable components that assist in project development.
+
+#### [Windows](windows.md)
+The windows documentation focuses on platform-specific considerations and implementations for Windows. It includes installation instructions, troubleshooting tips, and performance optimizations.