codevibr

COMPACTION.md

Jun 7th, 2026
18
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 3.96 KB | None | 0 0
  1. Read your project entry point in AGENTS.md and review the entire .agents knowledge base before making changes.
  2.  
  3. Goal:
  4. Compact the knowledge base into a maintainable architectural memory system.
  5.  
  6. The knowledge base should preserve:
  7.  
  8. * Current architecture
  9. * Current conventions
  10. * Current routing
  11. * Current visual/theme decisions
  12. * Current troubleshooting knowledge that remains relevant today
  13. * Owner-confirmed decisions
  14. * Upgrade risks
  15. * Maintenance warnings
  16.  
  17. The knowledge base should NOT preserve:
  18.  
  19. * Investigation timelines
  20. * Debugging narratives
  21. * Failed experiments
  22. * Step-by-step troubleshooting history
  23. * Temporary states that no longer exist
  24. * Historical project snapshots
  25. * Verification logs once a decision is established
  26. * Repeated information already documented elsewhere
  27.  
  28. Specific instructions:
  29.  
  30. 1. Session Notes Compaction
  31.  
  32. Review .agents/session-notes.md.
  33.  
  34. For each completed work item:
  35.  
  36. * Extract the final decision.
  37. * Extract any current maintenance warning.
  38. * Extract any architectural consequence.
  39.  
  40. Move those items into:
  41.  
  42. * decisions.md
  43. * troubleshooting.md
  44. * theme-overrides.md
  45. * architecture.md
  46.  
  47. as appropriate.
  48.  
  49. Then remove the historical narrative.
  50.  
  51. Examples of content to remove:
  52.  
  53. * timelines
  54. * root-cause investigations that are already resolved
  55. * browser testing logs
  56. * HTTP verification logs
  57. * build output logs
  58. * server restart history
  59. * iterative CSS experiments
  60. * discussion of approaches that were ultimately rejected
  61.  
  62. After compaction, session-notes.md should contain only:
  63.  
  64. * unresolved work
  65. * active investigations
  66. * work currently in progress
  67.  
  68. If no active investigations remain, replace the file with a short note explaining that historical work has been compacted into architectural documents.
  69.  
  70. 2. Troubleshooting Compaction
  71.  
  72. Review .agents/troubleshooting.md.
  73.  
  74. For resolved issues:
  75.  
  76. Keep:
  77.  
  78. * symptom summary
  79. * final root cause
  80. * final resolution
  81. * current maintenance guidance
  82.  
  83. Remove:
  84.  
  85. * investigation chronology
  86. * obsolete implementation details
  87. * superseded fixes
  88. * references to deleted code paths
  89. * duplicated verification records
  90.  
  91. Troubleshooting should answer:
  92.  
  93. "What do I need to know if this problem appears again?"
  94.  
  95. not
  96.  
  97. "How did we discover the answer?"
  98.  
  99. 3. Theme Override Compaction
  100.  
  101. Review .agents/theme-overrides.md.
  102.  
  103. Remove:
  104.  
  105. * historical investigations
  106. * rejected approaches
  107. * obsolete selector history
  108. * deleted component implementation details
  109.  
  110. Retain:
  111.  
  112. * current ownership
  113. * current selectors
  114. * current rationale
  115. * upgrade risks
  116. * maintenance warnings
  117.  
  118. Document only the current state.
  119.  
  120. 4. Knowledge Base De-duplication
  121.  
  122. Review:
  123.  
  124. * README.md
  125. * project-map.md
  126. * routing.md
  127. * site-style-guide.md
  128.  
  129. If the same information appears in multiple files:
  130.  
  131. Keep the most detailed version in the most appropriate file.
  132.  
  133. Replace duplicates with brief references.
  134.  
  135. Avoid maintaining the same architectural facts in multiple locations.
  136.  
  137. 5. Decisions Archive Entry
  138.  
  139. Add a new entry to .agents/decisions.md:
  140.  
  141. Date: <INSERT TODAY'S DATE IN TZ=AMERICA/NEW_YORK>
  142.  
  143. Decision:
  144. Knowledge Base Compaction
  145.  
  146. Rationale:
  147. The .agents knowledge base should function as long-term project memory, not a historical troubleshooting journal.
  148.  
  149. Policy:
  150.  
  151. * Preserve conclusions.
  152. * Preserve architecture.
  153. * Preserve conventions.
  154. * Preserve warnings.
  155. * Preserve upgrade risks.
  156. * Preserve owner-confirmed decisions.
  157. * Remove historical investigation narratives once issues are resolved.
  158. * Prefer Git history and commit history for implementation archaeology.
  159.  
  160. Expected Outcome:
  161.  
  162. The .agents knowledge base should become:
  163.  
  164. * Smaller
  165. * Faster to read
  166. * Easier for future agents to onboard
  167. * Focused on current project reality rather than historical discovery
  168.  
  169. At completion:
  170.  
  171. Provide:
  172.  
  173. * estimated line count reduction
  174. * files compacted
  175. * files left unchanged
  176. * any information intentionally preserved despite age because it still affects maintenance decisions
  177.  
Advertisement
Add Comment
Please, Sign In to add comment