Project Structure
- diagram.puml
- diagram.spec.json
- .gitkeep
- components.json
- containers.json
- persons.json
- software-systems.json
All files and folders are generated and updated by the user through the Mina UI. Although it is discouraged, you can potentially manually modify them outside of Mina, with just a text editor.
diagrams folder
Contains a subfolder for each C4 Model diagram type: Component (opens in a new tab), Container (opens in a new tab), Deployment (opens in a new tab), Dynamic (opens in a new tab), System Context (opens in a new tab), System Landscape (opens in a new tab).
Each diagram type subfolder contains a folder for each diagram created by the user.
The folder of a user-created diagram has the following characteristics:
- Folder name: lower-case and dash-case version of the diagram name.
- Folder content:
diagram.puml: contains the PlantUML code of the diagram.diagram.spec.json: contains the diagram specifications generated by Mina (e.g., positions of the elements, custom meta data, etc.).
library folder
Contains a file for each C4 element type can be saved a reused across the user diagrams. Check out the C4 Model Abstractions documentation (opens in a new tab) for the details about each element type.
Each JSON file could contain zero or more elements.
Please visit the library feature documentation for further details.
.gitignore file
Contains the default files and folder to be ignored by git.
hooks.js file
This is the entry Javascript file for coding your custom logic to be executed when Mina events are triggered. The default generated file contains an empty function for each supported hook.
Please visit the hooks feature documentation for further details.
mina.json file
Contains the project info and settings (name, version, description, OpenAI API Key, etc.).
README.md file
This is the default, auto-generated README file that you can modify to document your Mina project.
