Skip to content

Commit 659ab9f

Browse files
committed
docs: update documentation for v1.3.3 release
- Updated CHANGELOG.md with v1.3.3 release notes - Updated README.md to reflect new defaults and harmony improvements - Updated CONFIG.md with harmony section and new feature defaults - Documented status bar fix and default features being enabled - Enhanced harmony configuration documentation with all options
1 parent 6aab5a3 commit 659ab9f

3 files changed

Lines changed: 118 additions & 22 deletions

File tree

CHANGELOG.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
## [1.3.3] - 2024-12-24
11+
12+
### Changed
13+
- **Default Features Enabled** - All wizard options now default to enabled
14+
- `features.auto_save: true` (was false)
15+
- `features.show_tokens: true` (was false)
16+
- `ui.show_status_bar: true` (was false)
17+
- `harmony.show_detailed_thinking: true` (was false)
18+
- Provides better out-of-the-box experience for new users
19+
20+
### Fixed
21+
- **Status Bar Display** - Fixed status bar not showing between messages
22+
- Status bar now displays by default with agent name, model, query count, and session time
23+
- Resolves issue where status bar was hidden due to false default
24+
- **Harmony Detection Improvements** - Enhanced logging and documentation
25+
- Added detailed logging for harmony auto-detection process
26+
- Better documentation of `harmony.enabled` config options in example config
27+
- Fixed model_info type handling to prevent TypeError with status bar display
28+
1029
## [1.3.2] - 2024-12-24
1130

1231
### Added
@@ -334,6 +353,10 @@ For detailed documentation, see [README.md](README.md) and [docs/](docs/).
334353

335354
---
336355

356+
[1.3.3]: https://github.com/Open-Agent-Tools/Basic-Agent-Chat-Loop/releases/tag/v1.3.3
357+
[1.3.2]: https://github.com/Open-Agent-Tools/Basic-Agent-Chat-Loop/releases/tag/v1.3.2
358+
[1.3.1]: https://github.com/Open-Agent-Tools/Basic-Agent-Chat-Loop/releases/tag/v1.3.1
359+
[1.3.0]: https://github.com/Open-Agent-Tools/Basic-Agent-Chat-Loop/releases/tag/v1.3.0
337360
[0.3.7]: https://github.com/Open-Agent-Tools/Basic-Agent-Chat-Loop/releases/tag/v0.3.7
338361
[0.3.6]: https://github.com/Open-Agent-Tools/Basic-Agent-Chat-Loop/releases/tag/v0.3.6
339362
[0.3.5]: https://github.com/Open-Agent-Tools/Basic-Agent-Chat-Loop/releases/tag/v0.3.5

README.md

Lines changed: 37 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,7 @@ A configuration file (`~/.chatrc`) is automatically created on first use with re
179179

180180
```yaml
181181
features:
182+
auto_save: true # Automatically save conversations on exit
182183
show_tokens: true # Display token counts
183184
show_metadata: true # Show agent model/tools info
184185
rich_enabled: true # Enhanced formatting
@@ -191,6 +192,10 @@ audio:
191192
enabled: true # Play sound when agent completes
192193
notification_sound: null # Custom WAV file (null = bundled sound)
193194

195+
harmony:
196+
enabled: auto # Harmony processing (auto/yes/no)
197+
show_detailed_thinking: true # Show reasoning with labeled prefixes
198+
194199
behavior:
195200
max_retries: 3 # Retry attempts on failure
196201
timeout: 120.0 # Request timeout (seconds)
@@ -408,18 +413,27 @@ When a Harmony agent is detected, responses are automatically processed to:
408413
- Detect and format tool calls appropriately
409414
- Parse structured Harmony response formats
410415

411-
### Detailed Thinking Mode
416+
### Configuration
412417

413-
By default, only the final response is shown. You can enable detailed thinking mode to see the agent's internal reasoning with labeled prefixes:
418+
Control Harmony processing behavior:
414419

415-
**Configuration:**
416420
```yaml
417421
# In ~/.chatrc or .chatrc
418422
harmony:
419-
show_detailed_thinking: false # Default - only show final response
423+
enabled: auto # auto (default) / yes / no
424+
show_detailed_thinking: true # Default - show all channels with labels
420425
```
421426
422-
**With detailed thinking enabled (`true`):**
427+
**`harmony.enabled` options:**
428+
- `auto` (default) - Automatically detect harmony agents
429+
- `yes` - Force enable harmony processing for all agents
430+
- `no` - Disable harmony processing completely
431+
432+
### Detailed Thinking Mode
433+
434+
**By default, detailed thinking is enabled** - showing all channels with labeled prefixes:
435+
436+
**With detailed thinking enabled (`true`, default):**
423437
```
424438
💭 [REASONING]
425439
I need to analyze this query for potential bottlenecks...
@@ -436,7 +450,13 @@ This is a common pattern I see in legacy codebases...
436450
Here are three optimizations for your database query...
437451
```
438452
439-
**With detailed thinking disabled (`false`, default):**
453+
**To disable detailed thinking (set to `false`):**
454+
```yaml
455+
harmony:
456+
show_detailed_thinking: false # Only show final response
457+
```
458+
459+
**Output with detailed thinking disabled:**
440460
```
441461
Here are three optimizations for your database query...
442462
```
@@ -543,18 +563,17 @@ MIT License - see LICENSE file for details.
543563

544564
See [CHANGELOG.md](CHANGELOG.md) for detailed version history.
545565

546-
### Latest Release: v0.1.0 (2025-10-09)
547-
548-
Initial public release with:
549-
- 🏷️ Agent alias system
550-
- 📝 Prompt templates with auto-setup
551-
- 💰 Token tracking and cost estimation
552-
- ⚙️ YAML configuration with auto-setup
553-
- 📊 Status bar and session summaries
554-
- 🎨 Rich markdown rendering
555-
- 🔄 Automatic error recovery
556-
- 📜 Persistent command history
557-
- ✅ 61% test coverage (158 tests)
566+
### Latest Release: v1.3.3 (2024-12-24)
567+
568+
Hotfix release with default features enabled and harmony improvements:
569+
-**Default Features Enabled** - All features now enabled by default for better UX
570+
- `auto_save: true` - Save conversations automatically
571+
- `show_tokens: true` - Display token counts and costs
572+
- `show_status_bar: true` - Status bar with agent, model, queries, time
573+
- `show_detailed_thinking: true` - Show harmony reasoning channels
574+
- 🔧 **Status Bar Fix** - Status bar now displays correctly between messages
575+
- 📊 **Harmony Improvements** - Enhanced detection logging and documentation
576+
- 🎨 **Better Defaults** - Optimized out-of-the-box experience for new users
558577

559578
## Troubleshooting
560579

docs/CONFIG.md

Lines changed: 58 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ Toggle functionality on/off:
6868
6969
```yaml
7070
features:
71-
auto_save: false # Save conversations on exit
71+
auto_save: true # Save conversations on exit (default: true)
7272
rich_enabled: true # Use rich library for formatting
73-
show_tokens: false # Display token counts (future)
73+
show_tokens: true # Display token counts (default: true)
7474
show_metadata: true # Show agent metadata on startup
7575
readline_enabled: true # Command history
7676
```
@@ -109,11 +109,11 @@ ui:
109109
show_banner: true # Welcome banner
110110
show_thinking_indicator: true # "Thinking..." spinner
111111
show_duration: true # Query duration
112-
show_status_bar: false # Top status bar (agent, model, queries, time)
112+
show_status_bar: true # Top status bar (agent, model, queries, time)
113113
```
114114
115115
**Status Bar:**
116-
When enabled, shows a persistent status bar at the top:
116+
Enabled by default, shows a persistent status bar at the top:
117117
```
118118
┌─────────────────────────────────────────────────┐
119119
│ Clara │ Sonnet 4.5 │ 3 queries │ 12m 34s │
@@ -153,6 +153,55 @@ audio:
153153
enabled: false
154154
```
155155

156+
### Harmony
157+
158+
OpenAI Harmony format support for gpt-oss models:
159+
160+
```yaml
161+
harmony:
162+
enabled: auto # Harmony processing (auto/yes/no)
163+
show_detailed_thinking: true # Show reasoning with labeled prefixes
164+
```
165+
166+
**`harmony.enabled` options:**
167+
- `auto` (default) - Automatically detect harmony agents by checking for:
168+
- Explicit `uses_harmony` attribute on the agent
169+
- Model names containing "gpt-oss" or "harmony"
170+
- Harmony-specific methods or attributes
171+
- Agent class names containing "harmony"
172+
- `yes` - Force enable harmony processing for all agents
173+
- `no` - Disable harmony processing completely
174+
175+
**Detailed thinking mode:**
176+
When `show_detailed_thinking: true` (default), the agent's internal reasoning is displayed with labeled prefixes:
177+
```
178+
💭 [REASONING]
179+
I need to analyze this query...
180+
181+
📊 [ANALYSIS]
182+
Looking at the structure...
183+
184+
📝 [COMMENTARY]
185+
This is a common pattern...
186+
187+
💬 [RESPONSE]
188+
Here are the optimizations...
189+
```
190+
191+
When `show_detailed_thinking: false`, only the final response is shown:
192+
```
193+
Here are the optimizations...
194+
```
195+
196+
**Per-agent harmony settings:**
197+
```yaml
198+
agents:
199+
'My Harmony Agent':
200+
harmony:
201+
enabled: yes # Force enable for this agent
202+
show_detailed_thinking: false # Hide internal reasoning
203+
```
204+
156205
### Sessions
157206

158207
Conversation session management settings:
@@ -468,6 +517,10 @@ audio:
468517
enabled: boolean # Play sound when agent completes
469518
notification_sound: string | null # Path to WAV file or null for bundled sound
470519

520+
harmony:
521+
enabled: string # auto / yes / no - Harmony processing control
522+
show_detailed_thinking: boolean # Show reasoning with labeled prefixes
523+
471524
agents:
472525
'<agent_name>':
473526
# Any of the above sections can be overridden
@@ -477,6 +530,7 @@ agents:
477530
behavior: {...}
478531
ui: {...}
479532
audio: {...}
533+
harmony: {...}
480534
```
481535
482536
## See Also

0 commit comments

Comments
 (0)