From 313171de93bb2941c89b76a7f54b9b397675ef72 Mon Sep 17 00:00:00 2001 From: IamLRBA Date: Thu, 4 Dec 2025 01:42:01 +0300 Subject: [PATCH] feat: add documentation issue template Add comprehensive documentation issue template to complete the issue template suite. This template provides structured reporting for documentation issues, improvements, and requests. Features: - Component selection matching existing templates - Documentation type categorization (missing, outdated, unclear, etc.) - Impact level assessment (Critical, High, Medium, Low) - User impact identification - Contribution section to encourage community participation - Support for screenshots, examples, and related documentation links Completes the issue template suite started in PR #4. --- .github/ISSUE_TEMPLATE/documentation.md | 114 ++++++++++++++++++++++++ 1 file changed, 114 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/documentation.md diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 000000000..885ffd960 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,114 @@ +--- +name: Documentation Issue +about: Report documentation issues, suggest improvements, or request new documentation +title: '[Docs] Brief description of the issue or improvement' +labels: documentation +assignees: '' +--- + +## Component + +- [ ] formulus (React Native mobile app) +- [ ] formulus-formplayer (React web app) +- [ ] synkronus (Go backend server) +- [ ] synkronus-cli (Command-line utility) +- [ ] Design System / Design Tokens +- [ ] API Documentation +- [ ] Setup / Installation Guides +- [ ] Deployment Documentation +- [ ] General / Root Documentation +- [ ] Other (please specify) + +## Documentation Type + +- [ ] Missing documentation (documentation doesn't exist) +- [ ] Outdated documentation (information is incorrect or stale) +- [ ] Unclear documentation (hard to understand) +- [ ] Incomplete documentation (missing important details) +- [ ] Broken links or references +- [ ] Formatting or typo issues +- [ ] Translation needed +- [ ] New documentation needed +- [ ] Other (please describe) + +## Which part of the documentation needs improvement? + + +**File/Path:** +**Section:** +**URL (if applicable):** + +## Describe the issue or suggestion + + + + +### Current State + + + +### Problem or Gap + + +## Proposed Change (if any) + + + + +### Suggested Content + + + +### Suggested Structure + + +## Why is this change important? + + + + + + + + +**Impact Level:** +- [ ] Critical (blocks users or causes errors) +- [ ] High (causes confusion or incorrect usage) +- [ ] Medium (improves clarity or completeness) +- [ ] Low (nice to have, minor improvement) + +## Additional Context + +### Screenshots or Examples + + + +### Related Documentation + + + +### User Impact + +- [ ] New users / First-time setup +- [ ] Developers / Contributors +- [ ] End users / Consumers +- [ ] System administrators +- [ ] All users + +### Additional Information + + + + + + + +## Contribution + + +- [ ] I can contribute a fix/improvement +- [ ] I can review proposed changes +- [ ] I need help from maintainers + + +