Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arv-anshul/ineuron-project-docs-template
A automated way to create project's document for Ineuron Portal Projects.
https://github.com/arv-anshul/ineuron-project-docs-template
documentation ineuron-ai markdown physics-wallah project project-documentation python3 yaml
Last synced: 10 days ago
JSON representation
A automated way to create project's document for Ineuron Portal Projects.
- Host: GitHub
- URL: https://github.com/arv-anshul/ineuron-project-docs-template
- Owner: arv-anshul
- Created: 2023-07-16T09:34:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-25T09:33:20.000Z (over 1 year ago)
- Last Synced: 2023-09-25T16:02:55.821Z (over 1 year ago)
- Topics: documentation, ineuron-ai, markdown, physics-wallah, project, project-documentation, python3, yaml
- Language: Python
- Homepage:
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Ineuron's Projects Document Template
I know many developers are afraid of writing documentation of their projects. That's why I created this repository which helps you to create the project documentation in a easy way by just providing essential details about the project.
You can create all the **FIVE** documents with this i.e. **Architecture, LLD, HLD, WireFrame and DPR**.
### How to create documents
- 🤡 Clone this repo
```sh
git clone https://github.com/arv-anshul/ineuron-project-docs-template
```
- ⭐ Go to `./docs/yaml/` directory and fill the **YAML** document's fields with your project description.
- 🤖 Run `main.py`.
```sh
python main.py
```
- 📁 Now, a new directory (`export/markdowns/`) created which contains the documents but **in markdown format**.
- ♻️ You can convert those markdowns with some **md to pdf convertor app**.
> **Remember:** The **md to pdf converter app** must support `mermaid` graphs to render the graphs.
### Documentation Demo
#### 📝 [Architecture Document](https://github.com/arv-anshul/ineuron-money-laundering/blob/main/docs/Architecture.pdf)
#### 📝 [LLD Document](https://github.com/arv-anshul/ineuron-money-laundering/blob/main/docs/LLD.pdf)
#### 📝 [HLD Document](https://github.com/arv-anshul/ineuron-money-laundering/blob/main/docs/HLD.pdf)
#### 📝 [WireFrame Document](https://github.com/arv-anshul/ineuron-money-laundering/blob/main/docs/Wireframe.pdf)
#### 📝 [DPR Document](https://github.com/arv-anshul/ineuron-money-laundering/blob/main/docs/DPR.pdf)
### Raise Issue / Problem
If you have any query or problem you can raise [here](https://github.com/arv-anshul/ineuron-project-docs-template/issues/new/choose)