docs: update documentation for v0.3.0

- CHANGELOG.md: Add version sections for 0.2.x and 0.3.0, add known
  issues and planned features linking to GitHub issues #111-#115
- CONTRIBUTING.md: Update prerequisites to Bun, fix file structure
  to reflect tui-solid migration, update commands to use bun
- README.md: Add version badges, roadmap section with v0.4.0 plans,
  known issues section, and recent changes summary
This commit is contained in:
2026-02-04 23:14:35 -05:00
parent d78fed7da9
commit ad514a920c
3 changed files with 269 additions and 113 deletions

View File

@@ -4,6 +4,12 @@
<img src="assets/Codetyper_logo.png" alt="CodeTyper Logo" width="400">
</p>
<p align="center">
<a href="https://github.com/CarGDev/codetyper.cli/releases"><img src="https://img.shields.io/badge/version-0.3.0-blue" alt="Version"></a>
<a href="https://github.com/CarGDev/codetyper.cli/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-green" alt="License"></a>
<a href="https://bun.sh"><img src="https://img.shields.io/badge/runtime-Bun-orange" alt="Bun"></a>
</p>
An AI-powered terminal coding agent with an interactive TUI. CodeTyper autonomously executes coding tasks using tool calls with granular permission controls and intelligent provider routing.
## How It Works
@@ -392,6 +398,28 @@ Branch and rewind session history for experimentation.
Sessions are stored in `.codetyper/sessions/` with automatic commit message suggestions.
## Roadmap
### v0.4.0 - Agent Completion
The next major release focuses on production-ready autonomous agent execution:
| Feature | Issue | Status |
|---------|-------|--------|
| Plan Approval Gate | [#111](https://github.com/CarGDev/codetyper.cli/issues/111) | Planned |
| Diff Preview Before Write | [#112](https://github.com/CarGDev/codetyper.cli/issues/112) | Planned |
| Execution Control (Pause/Resume/Abort) | [#113](https://github.com/CarGDev/codetyper.cli/issues/113) | Planned |
| Consistent Model Behavior | [#114](https://github.com/CarGDev/codetyper.cli/issues/114) | Planned |
| Quality Gates (TypeScript, Lint, Tests) | [#115](https://github.com/CarGDev/codetyper.cli/issues/115) | Planned |
### Known Issues
- Agent mode executes without waiting for user plan approval
- Different LLM models may behave inconsistently during agent execution
- No diff preview before file modifications
See [CHANGELOG](docs/CHANGELOG.md) for full version history.
## Development
```bash
@@ -411,6 +439,14 @@ bun test
bun run lint
```
## Recent Changes (v0.3.0)
- **System Prompt Builder**: New modular prompt system with modes, tiers, and providers
- **Module Restructure**: Consistent internal organization with improved imports
- **Solid.js TUI**: Fully migrated to Solid.js + OpenTUI (removed legacy React/Ink)
See [CHANGELOG](docs/CHANGELOG.md) for complete version history.
## Documentation
- [Changelog](docs/CHANGELOG.md) - Version history and changes