{"id":25940576,"url":"https://github.com/joggrdocs/dungeons-and-docs","last_synced_at":"2025-10-25T16:16:39.618Z","repository":{"id":242590908,"uuid":"809984818","full_name":"joggrdocs/dungeons-and-docs","owner":"joggrdocs","description":"A curated collection of markdown templates, to help you on your quest for the Golden Codex of Perfect Documentation.","archived":false,"fork":false,"pushed_at":"2025-02-25T21:33:03.000Z","size":1277,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-25T22:22:15.416Z","etag":null,"topics":["docs","documentation","joggr","markdown"],"latest_commit_sha":null,"homepage":"https://joggr.io","language":null,"has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/joggrdocs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-03T20:39:03.000Z","updated_at":"2025-02-25T21:44:31.000Z","dependencies_parsed_at":"2024-06-03T23:36:46.028Z","dependency_job_id":"8cb0f54f-fe9c-452b-9784-c23399247fd4","html_url":"https://github.com/joggrdocs/dungeons-and-docs","commit_stats":null,"previous_names":["joggrdocs/joggr-templates","joggrdocs/docs-templates","joggrdocs/temple-of-templates","joggrdocs/dungeons-and-docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joggrdocs%2Fdungeons-and-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joggrdocs%2Fdungeons-and-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joggrdocs%2Fdungeons-and-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joggrdocs%2Fdungeons-and-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joggrdocs","download_url":"https://codeload.github.com/joggrdocs/dungeons-and-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241787482,"owners_count":20020101,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["docs","documentation","joggr","markdown"],"created_at":"2025-03-04T05:17:46.682Z","updated_at":"2025-10-25T16:16:39.598Z","avatar_url":"https://github.com/joggrdocs.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e [!WARNING]\n\u003e This repository is currently under heavy development!\n\n---\n\n\u003cdiv\u003e\n    \u003cp align=\"center\"\u003e\n        \u003cimg src=\".github/assets/cover.png\" align=\"center\" width=\"100%\" /\u003e\n    \u003c/p\u003e\n    \u003chr\u003e\n\u003c/div\u003e\n\n\n# Dungeons and Docs\n\nWelcome to Joggr's battle tested documentation templates that you can use on your quest for the Golden Codex of Perfect Documentation (aka a great docs setup). \n\nYou might ask: \"How can these templates help me on my quest?\"\n\n- 📝 **Easy to Use**: These templates are designed to be easy to use and customize for your team\n- 🚀 **Ready to Go**: All of our templates are battle-tested at the largest of enterprises \u0026 fastest of startups\n- 🧳 **Portable**: Since the templates are in markdown they can be imported anywhere that supports markdown (basically everywhere)\n- 🧙 **Wizard Approved**: Our templates are approved by the most powerful wizards in the land\n\n## Quest for the Golden Codex of Perfect Documentation\n\nTo get started on your journey, venture into the [/templates](/templates) directory and explore the templates that await you. Each template is designed to help you document your projects, processes, standards, team, and architecture with ease. \n\n\u003e [!TIP]\n\u003e You can also use the quick links below to teleport to the template of your choice.\n\n\u003cdetails\u003e\n\u003csummary\u003e🚪 No matter what you do don't open this door\u003c/summary\u003e\n\n\u003e DM: You enter a dark and musty room filled with the smell of old parchment and you see a sign that reads \"Enterprise Wiki\". You feel a sense of foreboding as you step forward.\n\u003e \n\u003e DM: Roll for initiative 😏\n\n\u003c/details\u003e\n\n\n## Templates\n\n- [Project](#project) - Templates for setting up, contributing to, and deploying projects\n- [Process \u0026 Standard](#process--standard) - Templates for documenting development processes, standards, and best practices\n- [Team](#team) - Templates for defining team roles, responsibilities, and product overview\n- [Architecture](#architecture) - Templates for documenting service architecture, components, and interactions \n\n### Project\n\nTemplates for setting up, contributing to, and deploying projects (usually in a repository or a directory in a monorepo).\n\n| Template Name | Description | Link |\n|---------------|-------------|------|\n| `Local Setup Guide`    | A step-by-step guide to help developers quickly set up their development environment, including installing dependencies, configuring settings, and running the project locally. | [View](https://github.com/joggrdocs/dungeons-and-docs/blob/main/templates/projects/setup-local-environment.md) |\n| `Contributions Guidelines` | A set of rules and best practices for contributing to the project, including code style, pull request process, issue reporting, and review expectations. | [View](https://github.com/joggrdocs/dungeons-and-docs/blob/main/templates/projects/contribution-guidelines.md) |\n| `Deployment Guide` | A step-by-step manual for deploying the project, covering environment setup, build commands, configuration settings, and best practices. | [View](https://github.com/joggrdocs/dungeons-and-docs/blob/main/templates/projects/deployment-guide.md) |\n\n### Process \u0026 Standard\n\nTemplates for documenting development processes, standards, and best practices.\n\n| Template Name | Description | Link |\n|---------------|-------------|------|\n| `Development Process` | A guide detailing how an idea moves from inception to production, outlining each stage—planning, development, testing, and deployment—along with the definition of done at every step. | [View](https://github.com/joggrdocs/dungeons-and-docs/blob/main/templates/process-standards/software-development-process.md) |\n| `Incident Management Process` | A structured guide covering incident detection, classification, and resolution, along with the tools used and runbook links. | [View](https://github.com/joggrdocs/dungeons-and-docs/blob/main/templates/process-standards/incident-management-process.md) |\n| `Documentation Standards` | A guide to writing clear, discoverable, and team-driven documentation to speed up development, improve onboarding, and future-proof knowledge. | [View](https://github.com/joggrdocs/dungeons-and-docs/blob/main/templates/process-standards/documentation-standards.md) |\n| `Code Style Standards` | A set of best practices ensuring consistent, readable, and maintainable code across the team. Covers naming conventions, comments, linting, \u0026 formatting. | [View](https://github.com/joggrdocs/dungeons-and-docs/blob/main/templates/process-standards/code-style-standard.md) |\n\n### Team\n\nTemplates for defining team roles, responsibilities, and product overview.\n\n| Template Name | Description | Link |\n|---------------|-------------|------|\n| `Product Overview` |  A structured guide to clearly define what your app does, the problem it solves, and how it improves users’ lives. | [View](https://github.com/joggrdocs/dungeons-and-docs/blob/main/templates/team/product-overview.md) |\n| `Team Overview` | A guide outlining team roles, responsibilities, key contacts and who owns what.  | [View](https://github.com/joggrdocs/dungeons-and-docs/blob/main/templates/team/team-overview.md) |\n\n### Architecture\n\nTemplates for documenting service architecture, components, and interactions.\n\n| Template Name | Description | Link |\n|---------------|-------------|------|\n| `Service Architecture` | A structured guide \u0026 diagram for documenting the services, third party services, and key components that make up a platform and how they interact. | [View](https://github.com/joggrdocs/dungeons-and-docs/blob/main/templates/architecture/service-architecture.md) |\n\n\n\u003c!-- Signup footer --\u003e\n\u003cbr\u003e\n\u003chr\u003e\n\u003ch2 align=\"center\"\u003e\n   ⚡️ Want to sign up for Joggr?\n\u003c/h2\u003e\n\u003cp align=\"center\"\u003e\n    You can sign up for free at our website:  \u003ca href=\"https://www.joggr.io/signup?utm_source=github\u0026utm_medium=org-readme\u0026utm_campaign=static-docs\"\u003ehttps://joggr.io\u003c/a\u003e\u003cbr\u003e\n    (or click button below 👇)\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.joggr.io/signup?utm_source=github\u0026utm_medium=org-readme\u0026utm_campaign=static-docs\"\u003e\n    \u003cimg src=\"https://assets.joggr.io/github/badges/signup-badge.svg\" width=\"250px\" alt=\"Sign up\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\u003cbr\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoggrdocs%2Fdungeons-and-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoggrdocs%2Fdungeons-and-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoggrdocs%2Fdungeons-and-docs/lists"}