docs: add issues capture system and KB documentation
Some checks failed
KB Lint / validate (push) Has been cancelled
Some checks failed
KB Lint / validate (push) Has been cancelled
This commit adds the issues capture system from PAIRS project and documents it in the KB system, following all KB system rules for changelog and index updates. ## What Was Added ### 1. Issues Capture System (docs/issues/) **docs/issues/README.md** - System documentation: - Purpose and workflow for quick issue capture - File naming convention (YYYY-MM-DD--short-description.md) - Issue types (bug, feature, insight, structural, improvement, question) - Template fields and best practices - Integration with Gitea platform - Future automation possibilities **docs/issues/template.md** - Issue file template: - Minimal required fields (title, type, date, status) - Optional fields (description, impact, notes, related) - Gitea issue tracking section - Simple, quick-capture format **docs/issues/2025-11-11--gitea-runner-setup-request.md** - Moved from .github/: - Gitea Actions runner configuration request - Updated to match issue template format - Includes type, date, status fields - Ready for compilation to Gitea issue ### 2. KB Documentation Entry **kb/02_systems/2025-11-11--issues-capture-system--note.md** - KB entry: - Documents the issues capture system structure and workflow - Explains quick capture process - Describes compilation to Gitea issues - Includes best practices and integration points - Properly categorized in 02_systems/ (infrastructure/tooling) - Complete frontmatter with all 18 required fields ### 3. KB System Updates **kb/CHANGELOG.md** - Updated: - Added entry for issues capture system documentation - Date: 2025-11-11 - Documents KB file addition **kb/_index.md** - Regenerated: - Index updated via generate-index.sh script - New KB file appears in 02_systems category - Topics indexed: documentation, issue-tracking, workflow, gitea - Tags indexed: issues, capture, documentation, gitea, workflow - Summary updated with file count ## Why This Implementation ### Quick Issue Capture The issues capture system provides a lightweight staging area for capturing issues, insights, bugs, and features as you encounter them. This enables quick capture without the overhead of creating formal Gitea issues immediately. ### Markdown-Based Workflow Issues are captured as markdown files, making them easy to edit, version control, and review. This provides flexibility before committing to formal issue tracking. ### Later Compilation Issues can be batch-processed into Gitea issues when ready, allowing for review, prioritization, and grouping before creating formal issues. ### Documentation in KB The issues capture system is documented in the KB system, making it discoverable and providing reference material for the workflow. ## Technical Details ### File Structure ### Issue File Format - **Naming**: - **Template**: Minimal fields for quick capture - **Status**: captured → reviewed → compiled - **Integration**: Links to Gitea issues when compiled ### KB Entry Details - **Category**: 02_systems (infrastructure, DevOps, tooling) - **Type**: note - **Topics**: documentation, issue-tracking, workflow, gitea - **Tags**: issues, capture, documentation, gitea, workflow - **Routing Confidence**: 0.95 (high confidence) ## Files Added/Modified ### Added - docs/issues/README.md - Issues capture system documentation - docs/issues/template.md - Issue file template - docs/issues/2025-11-11--gitea-runner-setup-request.md - Runner setup request (moved from .github/) - kb/02_systems/2025-11-11--issues-capture-system--note.md - KB documentation entry ### Modified - kb/CHANGELOG.md - Added entry for new KB file - kb/_index.md - Regenerated with new KB file indexed ## KB System Compliance ✅ KB file follows naming convention (YYYY-MM-DD--slug--type.md) ✅ KB file has complete frontmatter (all 18 required fields) ✅ KB file date matches filename date ✅ KB file type matches filename type ✅ KB changelog updated with entry ✅ KB index regenerated via script ✅ All changes committed together ## Related - Source: PAIRS-for-the-Individual project (docs/issues/) - KB System: kb/README.md - KB Changelog: kb/CHANGELOG.md - KB Index: kb/_index.md - Gitea Documentation: docs/GITEA/
This commit is contained in:
@@ -2,6 +2,18 @@
|
||||
|
||||
All notable changes to KB files and system.
|
||||
|
||||
## [2025-11-11] Issues Capture System Documentation
|
||||
|
||||
### Added
|
||||
- `kb/02_systems/2025-11-11--issues-capture-system--note.md` - Documentation for issues capture system in docs/issues/ folder
|
||||
|
||||
### Notes
|
||||
- Documents the issues capture system workflow and structure
|
||||
- Provides reference for quick issue capture before compiling to Gitea issues
|
||||
- Includes integration with Gitea platform and best practices
|
||||
|
||||
---
|
||||
|
||||
## [2025-01-27] KB System Setup
|
||||
|
||||
### Added
|
||||
|
||||
Reference in New Issue
Block a user