- Add issue templates for agents, packs, features, bugs, infra, and docs - Add labels.yml with BlackRoad OS standard labels (team, type, prio, status) - Add PR template with atomic commit guidelines - Add CONTRIBUTING.md with development guidelines - Add docs/REPOSITORY_ROLE.md documenting this repo's ecosystem role - Update README.md with badges, ecosystem links, and comprehensive docs Co-authored-by: blackboxprogramming <118287761+blackboxprogramming@users.noreply.github.com>
75 lines
1.9 KiB
YAML
75 lines
1.9 KiB
YAML
name: Documentation Issue
|
|
description: Report missing, incorrect, or unclear documentation
|
|
title: "[DOC] "
|
|
labels: ["type:doc", "team:prism", "status:ready"]
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
## Documentation Issue Template
|
|
Use this template for documentation improvements, corrections, or additions.
|
|
|
|
- type: dropdown
|
|
id: priority
|
|
attributes:
|
|
label: Priority
|
|
description: What is the priority of this documentation issue?
|
|
options:
|
|
- prio:P0
|
|
- prio:P1
|
|
- prio:P2
|
|
validations:
|
|
required: true
|
|
|
|
- type: dropdown
|
|
id: doc-type
|
|
attributes:
|
|
label: Documentation Type
|
|
description: What type of documentation needs attention?
|
|
options:
|
|
- README
|
|
- API Documentation
|
|
- Setup/Installation Guide
|
|
- Contributing Guide
|
|
- Architecture/Design Docs
|
|
- Code Comments
|
|
- Other
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: description
|
|
attributes:
|
|
label: Description
|
|
description: Describe what's missing, incorrect, or unclear
|
|
placeholder: "The README doesn't explain how to configure environment variables..."
|
|
validations:
|
|
required: true
|
|
|
|
- type: input
|
|
id: location
|
|
attributes:
|
|
label: Documentation Location
|
|
description: Where is the documentation located?
|
|
placeholder: "README.md, docs/SETUP.md, etc."
|
|
validations:
|
|
required: false
|
|
|
|
- type: textarea
|
|
id: suggestion
|
|
attributes:
|
|
label: Suggested Improvement
|
|
description: How should the documentation be improved?
|
|
placeholder: "Add a section explaining .env.local configuration..."
|
|
validations:
|
|
required: false
|
|
|
|
- type: textarea
|
|
id: context
|
|
attributes:
|
|
label: Additional Context
|
|
description: Any other relevant information
|
|
placeholder: "Examples, related docs, etc..."
|
|
validations:
|
|
required: false
|