jwalsh / jwalsh/2048-cli-debug
Add org-mode experimental journal for literate debugging
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
## Feature Request
Add support for documenting debugging experiments in org-mode format with literate programming capabilities.
## Motivation
- Scientific approach to debugging requires proper documentation
- Current markdown journal lacks interactive/executable elements
- Org-mode enables reproducible experiments with embedded code
## Implementation
- [x] Create experiments.org with proper structure
- [ ] Add babel support for executing code blocks
- [ ] Create templates for new experiments
- [ ] Add export capabilities (HTML, PDF)
- [ ] Link experiments to GitHub issues
## Benefits
- Reproducible debugging sessions
- Clear hypothesis → method → observation → conclusion flow
- Executable documentation
- Better knowledge transfer between sessions
Inspired by 'Laboratory Life' approach to documenting actual scientific discovery.
Contributor guide
Assessment
This issue has not been assessed yet.