{"id":23527353,"url":"https://github.com/arv-anshul/ineuron-project-docs-template","last_synced_at":"2026-04-18T06:37:59.384Z","repository":{"id":181581030,"uuid":"666994550","full_name":"arv-anshul/ineuron-project-docs-template","owner":"arv-anshul","description":"A automated way to create project's document for Ineuron Portal Projects.","archived":false,"fork":false,"pushed_at":"2023-09-25T09:33:20.000Z","size":31,"stargazers_count":1,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-14T10:21:42.376Z","etag":null,"topics":["documentation","ineuron-ai","markdown","physics-wallah","project","project-documentation","python3","yaml"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arv-anshul.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-07-16T09:34:48.000Z","updated_at":"2024-06-14T03:15:11.000Z","dependencies_parsed_at":null,"dependency_job_id":"61c4eef8-b454-4acb-b8ce-259af44c59e0","html_url":"https://github.com/arv-anshul/ineuron-project-docs-template","commit_stats":null,"previous_names":["arv-anshul/ineuron-project-docs-template"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/arv-anshul/ineuron-project-docs-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arv-anshul%2Fineuron-project-docs-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arv-anshul%2Fineuron-project-docs-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arv-anshul%2Fineuron-project-docs-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arv-anshul%2Fineuron-project-docs-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arv-anshul","download_url":"https://codeload.github.com/arv-anshul/ineuron-project-docs-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arv-anshul%2Fineuron-project-docs-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31959883,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T00:39:45.007Z","status":"online","status_checked_at":"2026-04-18T02:00:07.018Z","response_time":103,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","ineuron-ai","markdown","physics-wallah","project","project-documentation","python3","yaml"],"created_at":"2024-12-25T20:14:03.590Z","updated_at":"2026-04-18T06:37:59.365Z","avatar_url":"https://github.com/arv-anshul.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ineuron's Projects Document Template\n\nI 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.\n\nYou can create all the **FIVE** documents with this i.e. **Architecture, LLD, HLD, WireFrame and DPR**.\n\n### How to create documents\n\n- 🤡 Clone this repo\n\n```sh\ngit clone https://github.com/arv-anshul/ineuron-project-docs-template\n```\n\n- ⭐ Go to `./docs/yaml/` directory and fill the **YAML** document's fields with your project description.\n\n- 🤖 Run `main.py`.\n\n```sh\npython main.py\n```\n\n- 📁 Now, a new directory (`export/markdowns/`) created which contains the documents but **in markdown format**.\n\n- ♻️ You can convert those markdowns with some **md to pdf convertor app**.\n\n\u003e **Remember:** The **md to pdf converter app** must support `mermaid` graphs to render the graphs.\n\n### Documentation Demo\n\n#### 📝 [Architecture Document](https://github.com/arv-anshul/ineuron-money-laundering/blob/main/docs/Architecture.pdf)\n\n#### 📝 [LLD Document](https://github.com/arv-anshul/ineuron-money-laundering/blob/main/docs/LLD.pdf)\n\n#### 📝 [HLD Document](https://github.com/arv-anshul/ineuron-money-laundering/blob/main/docs/HLD.pdf)\n\n#### 📝 [WireFrame Document](https://github.com/arv-anshul/ineuron-money-laundering/blob/main/docs/Wireframe.pdf)\n\n#### 📝 [DPR Document](https://github.com/arv-anshul/ineuron-money-laundering/blob/main/docs/DPR.pdf)\n\n### Raise Issue / Problem\n\nIf you have any query or problem you can raise [here](https://github.com/arv-anshul/ineuron-project-docs-template/issues/new/choose)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farv-anshul%2Fineuron-project-docs-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farv-anshul%2Fineuron-project-docs-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farv-anshul%2Fineuron-project-docs-template/lists"}