updated the Documentation for version 0.0.12

Author: nikolasfil

docs/Makefile

@@ -0,0 +1,16 @@
+SHELL := /bin/bash 
+DEST=.
+PYTHON=python3
+PACKAGE?=ctfsolver
+PACKAGE_DIR=../app/ctfsolver
+
+SPHINX_DIR = sphinx
+
+
+create-graphviz :
+
+	pyreverse -o dot -p $(PACKAGE) $(PACKAGE_DIR)
+	mv classes_$(PACKAGE).dot $(SPHINX_DIR)/images/
+	mv packages_$(PACKAGE).dot $(SPHINX_DIR)/images/
+	dot -Tpng $(SPHINX_DIR)/images/classes_$(PACKAGE).dot -o $(SPHINX_DIR)/images/classes_$(PACKAGE).png
+	dot -Tpng $(SPHINX_DIR)/images/packages_$(PACKAGE).dot -o $(SPHINX_DIR)/images/packages_$(PACKAGE).png

docs/README.md

@@ -1,5 +1,9 @@
 ## Documentation
 
+> [!WARNING]
+> The manual documentation is still under development
+> The automatic documentation is available at the [ctfsolver documentation](https://nikolasfil.github.io/CTFSolverScript/ctfsolver/)
+
 ### Module ctfsolver documentation :
 
 [ctfsolver](https://nikolasfil.github.io/CTFSolverScript/ctfsolver/)
@@ -8,6 +12,7 @@ Uses modules :
 
 - pwntools
 - scapy
+- requests
 
 ### Module ctfsolver bash commands
 

docs/TODO/TODO.md

@@ -9,6 +9,12 @@
 ## Functionality
 
 - add a list of files that can be considered part of the challenge for easier approach
+- add more folders to the standardization
+- rethink the way bashcommands are used
+- recheck the code
+- tree the folders to get the names. Makeshift Database for the challenges.
+- Also try to correlate the Obsidian Writeups with the Makeshift database
+- Add a way to check if there are challenges that don't have the proper folder structure
 
 ## Publish in pip ?
 
@@ -27,5 +33,20 @@ Add the documentation on the commands to run and how the whole package is meant
 
 ## Discerning libraries
 
-- Transfer all the pcap files to a different class and just inher it
 - add a template for every other library used for the solver
+
+## Challenges
+
+- Incorporate : `/home/figaro/CTF/Categories/Forensics/ctflearn/HailCeasar` into the solver
+- Find every other challenge that has a solution.py and add it
+- In every folder that has a solution include the original function of the solution
+
+- Make a function that finds all the helpers that have more than the original CTFSolver function !!!
+
+- Add a print function that iterates with a for loop if it is given a tuple, list, set or dict. Automatically turns them into strings if they are not
+
+
+## Automation 
+
+- automatic cd to predefined folder, and cdir to new challenges 
+- 

docs/TODO/decorator.md

@@ -0,0 +1,4 @@
+
+Decorator for the auto reporting 
+Decorator for verbose level ? 
+

docs/TODO/file/README.md

@@ -0,0 +1,4 @@
+
+- Split the file and the folder manager into two 
+- Minimize the calling of each manager 
+- This is for optimization's sake 

docs/TODO/modules/folders.md docs/TODO/folders/README.mddocs/TODO/modules/folders.md renamed to docs/TODO/folders/README.md

@@ -0,0 +1,4 @@
+
+
+To add functions, have a backup folder for the script
+Normally you would save it inside the venv, but you would have a file for backup purposes

docs/TODO/function_adder.md

@@ -0,0 +1,6 @@
+
+
+To continue the Linking 
+I need to finish the functions that will look for specific categories and or not sites in the documents, and if they find documents for challenges that don't have a folder, will create them. 
+For that I need to work on the manager_file to be able to write the parent without adding it automatically 
+ 

docs/TODO/linking.md

@@ -0,0 +1,7 @@
+Capabilities
+
+- Designate your plugin directory to the config file
+- Load plugins from the designated directory
+  - inline tool can have the option to load plugins
+  - inline tool can have the option to load plugins and add them to the init file
+- Perhaps add the plugins to the config file ?

docs/TODO/plugins/README.md

@@ -0,0 +1,4 @@
+Functionality:
+
+- Will be able to read the contents of the solution template, the actual template
+- will be able to create another solve as attempts