coulomb/markitect-main
2
0
Fork 0
Code Issues 60 Pull Requests Actions 1 Projects 12 Releases 1 Wiki Activity

Issue #49.3: Organize development documentation (move diaries, reports, guides to docs/ subdirs) #76

New Issue
Open
opened 2025-10-02 19:36:53 +00:00 by tegwick · 0 comments
tegwick commented 2025-10-02 19:36:53 +00:00
Owner
Copy Link

Summary

Reorganize scattered development documentation files into proper docs/ subdirectory structure to reduce clutter and improve maintainability following DRY principles.

Parent Issue

This is a subtask of Issue #49: "Organize documentation using the DRY principle and arc42"

Files to Move/Organize

Development Diaries (to docs/development/diaries/)

  • DEVELOPMENT_DIARY_ENTRY.md
  • DEVELOPMENT_DIARY_ENTRY_PERF_TRACKING.md
  • .aider.chat.history.md

Development Guides (to docs/development/guides/)

  • ERROR_HANDLING_GUIDE.md
  • LEGACY_AGENT_GUIDE.md
  • CLI_TUTORIAL.md

Development Reports (to docs/development/reports/)

  • AGENT_TOOLING_OPTIMIZATION_REPORT.md
  • CLI_REGRESSION_FIX_REPORT.md
  • TEST_COVERAGE_REPORT.md
  • USE_CASES_GAP_ANALYSIS.md

Testing Documentation (to docs/development/testing/)

  • TEST_ARCHITECTURE.md
  • ARCHITECTURAL_CHAOS_TESTING_ISSUE.md

Acceptance Criteria

  • Create docs/development/ subdirectory structure
  • Move all development files to appropriate subdirectories
  • Update internal links and references
  • Create index files for each subdirectory
  • Update main docs/README.md with navigation links
  • Ensure no broken links remain
  • Remove any duplicated content

Estimated Effort

3 hours

Labels

  • documentation
  • organization
  • dry-principle
  • development
  • priority:high

Dependencies

None - this can be done independently

## Summary Reorganize scattered development documentation files into proper docs/ subdirectory structure to reduce clutter and improve maintainability following DRY principles. ## Parent Issue This is a subtask of Issue #49: "Organize documentation using the DRY principle and arc42" ## Files to Move/Organize ### Development Diaries (to docs/development/diaries/) - DEVELOPMENT_DIARY_ENTRY.md - DEVELOPMENT_DIARY_ENTRY_PERF_TRACKING.md - .aider.chat.history.md ### Development Guides (to docs/development/guides/) - ERROR_HANDLING_GUIDE.md - LEGACY_AGENT_GUIDE.md - CLI_TUTORIAL.md ### Development Reports (to docs/development/reports/) - AGENT_TOOLING_OPTIMIZATION_REPORT.md - CLI_REGRESSION_FIX_REPORT.md - TEST_COVERAGE_REPORT.md - USE_CASES_GAP_ANALYSIS.md ### Testing Documentation (to docs/development/testing/) - TEST_ARCHITECTURE.md - ARCHITECTURAL_CHAOS_TESTING_ISSUE.md ## Acceptance Criteria - [ ] Create docs/development/ subdirectory structure - [ ] Move all development files to appropriate subdirectories - [ ] Update internal links and references - [ ] Create index files for each subdirectory - [ ] Update main docs/README.md with navigation links - [ ] Ensure no broken links remain - [ ] Remove any duplicated content ## Estimated Effort 3 hours ## Labels - documentation - organization - dry-principle - development - priority:high ## Dependencies None - this can be done independently
tegwick added this to the Clean Repository Standard project 2025-10-02 20:15:32 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
priority:critical
Critical priority issue
 priority:high
High priority issue
 priority:low
Low priority issue
 priority:medium
Medium priority issue
 status:active
Issues currently being worked on
 status:blocked
Issues blocked by dependencies
 status:done
Completed issues
 status:review
Issues under review
 status:todo
Issues ready to be worked on
 type:bug
Bug report
 type:documentation
Documentation update
 type:enhancement
Enhancement to existing feature
 type:feature
New feature request
 wish
Feature wishlist item - idea to be discussed and refined
 wish/archived
Archived or rejected wishlist item
 wish/discussion
Wishlist item currently being discussed and refined
 wish/draft
Wishlist item with initial draft specification
 wish/ready
Wishlist item ready to become a regular issue
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project Clean Repository Standard
Assignees
Clear assignees
bubble-reader tegwick
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: coulomb/markitect-main#76
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?