Community Health Files: - CODE_OF_CONDUCT.md: Contributor Covenant v2.1 - Contact: conduct@agenticgovernance.digital - Standard enforcement guidelines Issue Templates: - Bug Report: Tractatus-specific (framework components, env details) - Feature Request: Includes values impact assessment - Documentation: Helps improve docs quality - Config: Links to Discussions, docs, media inquiries CI/CD: - GitHub Actions workflow for PR/push validation - ESLint linting (zero warnings policy) - Jest tests on Node 18.x + 20.x - Codecov integration for coverage tracking Purpose: Signal project maturity to researchers and contributors Refs: SESSION_HANDOFF_2025-10-14 Priority 2
72 lines
1.9 KiB
YAML
72 lines
1.9 KiB
YAML
name: 📖 Documentation Issue
|
|
description: Report missing, unclear, or incorrect documentation
|
|
title: "[Docs]: "
|
|
labels: ["documentation", "needs-triage"]
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Help us improve our documentation! Please describe what's missing, unclear, or incorrect.
|
|
|
|
- type: dropdown
|
|
id: doc-type
|
|
attributes:
|
|
label: Documentation Type
|
|
description: What type of documentation needs improvement?
|
|
options:
|
|
- Technical Documentation
|
|
- API Reference
|
|
- Implementation Guide
|
|
- Conceptual/Theoretical
|
|
- Tutorial/Getting Started
|
|
- Case Study
|
|
- Other
|
|
validations:
|
|
required: true
|
|
|
|
- type: input
|
|
id: page
|
|
attributes:
|
|
label: Page/Section
|
|
description: Which page or section needs improvement?
|
|
placeholder: "e.g., docs.html#boundary-enforcer or /implementer.html"
|
|
validations:
|
|
required: true
|
|
|
|
- type: dropdown
|
|
id: issue-type
|
|
attributes:
|
|
label: Issue Type
|
|
description: What kind of documentation issue is this?
|
|
options:
|
|
- Missing information
|
|
- Unclear explanation
|
|
- Incorrect information
|
|
- Outdated content
|
|
- Typo or grammar
|
|
- Broken link
|
|
- Other
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: problem
|
|
attributes:
|
|
label: Problem Description
|
|
description: What's wrong or missing?
|
|
placeholder: The current documentation says..., but it should...
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: suggestion
|
|
attributes:
|
|
label: Suggested Improvement
|
|
description: How should this be improved?
|
|
placeholder: I suggest adding/changing...
|
|
|
|
- type: textarea
|
|
id: context
|
|
attributes:
|
|
label: Additional Context
|
|
description: Any other context (audience perspective, use case, etc.)
|