Documentation
This chapter explains how the documentation of this project. It explains
1. The documentation process and tools used.
2. Future documentation improvements
The tools used include :
- Mdbook - For generating a static website
- Mark Down Language - for writing the actual content. Content that can be parsed by other programs or converted to html/css/js files.
- Git/Github - For continuous maintainance and storage
- Mermaid : For drawing state diagrams, schemas, graphs, flowcharts... using text/code.
- Excalidraw : For drawing diagrams
- RustDocs : generating documentation from comments within the code and publishing it to crates.io
- Visual Studio Code : Combining all the above tools in one environment
More information of how these tools were used together is found in the next chapter.
[undone]
Future desires [undone]
- draw the whole system design on one piece of canvas.
- Let the canvas hve an infinite zoom feature.
- The user can then zoom in and out infinitely. From the high level components to the actual code_state diagrams
- The above system should probably use markdown, mdbooks, excalidraw, mermaid.js
- Uses nested state diagrams to describe code --- mermaid.js state diagrams
Even more future [undone]
- attach chat-gpt like querying within the system design diagram