e48adbcb00
- Migrated from Python pre-commit to NodeJS-native solution - Reorganized documentation structure - Set up Husky + lint-staged for efficient pre-commit hooks - Fixed Dockerfile healthcheck issue - Added comprehensive documentation index
121 lines
3.1 KiB
YAML
121 lines
3.1 KiB
YAML
name: 📚 Documentation Issue
|
|
description: Report problems with documentation or suggest improvements
|
|
title: '[DOCS] '
|
|
labels: ['documentation', 'needs-triage']
|
|
assignees: []
|
|
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Help us improve our documentation! Report issues or suggest enhancements to make it more helpful.
|
|
|
|
- type: dropdown
|
|
id: doc-type
|
|
attributes:
|
|
label: Documentation Type
|
|
description: What type of documentation needs attention?
|
|
options:
|
|
- README.md
|
|
- API Documentation
|
|
- Security Guide
|
|
- Deployment Guide
|
|
- Contributing Guide
|
|
- Code Comments
|
|
- User Guide
|
|
- Setup Instructions
|
|
- Other
|
|
validations:
|
|
required: true
|
|
|
|
- type: dropdown
|
|
id: issue-type
|
|
attributes:
|
|
label: Issue Type
|
|
description: What kind of documentation issue is this?
|
|
options:
|
|
- Missing information
|
|
- Incorrect information
|
|
- Unclear instructions
|
|
- Outdated content
|
|
- Broken links
|
|
- Formatting issues
|
|
- Spelling/grammar errors
|
|
- Enhancement suggestion
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: description
|
|
attributes:
|
|
label: Description
|
|
description: Describe the documentation issue or improvement
|
|
placeholder: The documentation issue is...
|
|
validations:
|
|
required: true
|
|
|
|
- type: input
|
|
id: location
|
|
attributes:
|
|
label: Document Location
|
|
description: Which file or section needs attention?
|
|
placeholder: e.g., README.md line 45, docs/API.md section "Authentication"
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: current-content
|
|
attributes:
|
|
label: Current Content (if applicable)
|
|
description: Quote the current text that needs to be changed
|
|
placeholder: Current text...
|
|
validations:
|
|
required: false
|
|
|
|
- type: textarea
|
|
id: suggested-content
|
|
attributes:
|
|
label: Suggested Content
|
|
description: Provide the corrected or improved content
|
|
placeholder: Suggested replacement...
|
|
validations:
|
|
required: false
|
|
|
|
- type: dropdown
|
|
id: audience
|
|
attributes:
|
|
label: Target Audience
|
|
description: Who is the primary audience for this documentation?
|
|
options:
|
|
- End users
|
|
- Developers
|
|
- System administrators
|
|
- Healthcare providers
|
|
- Contributors
|
|
- All audiences
|
|
validations:
|
|
required: true
|
|
|
|
- type: checkboxes
|
|
id: impact
|
|
attributes:
|
|
label: Impact
|
|
description: What areas does this documentation issue affect?
|
|
options:
|
|
- label: New user onboarding
|
|
- label: Development setup
|
|
- label: Deployment process
|
|
- label: Security configuration
|
|
- label: API usage
|
|
- label: Troubleshooting
|
|
- label: Contributing process
|
|
|
|
- type: textarea
|
|
id: additional-context
|
|
attributes:
|
|
label: Additional Context
|
|
description: Any other relevant information
|
|
placeholder: Additional context...
|
|
validations:
|
|
required: false
|