Skip to content

Release: merge develop to main#108

Merged
yimsk merged 2 commits intomainfrom
develop
Jan 5, 2026
Merged

Release: merge develop to main#108
yimsk merged 2 commits intomainfrom
develop

Conversation

@yimsk
Copy link
Copy Markdown
Contributor

@yimsk yimsk commented Jan 5, 2026

Summary

  • docs: add missing commands to help view (:login, :theme, :autosave, :q)

@claude
Copy link
Copy Markdown

claude Bot commented Jan 5, 2026

Code Review Summary

This PR adds documentation for missing command-mode commands (:login, :theme, :autosave, :q) to the help view. The changes are straightforward and improve user discoverability of existing features.

✅ Strengths

  1. Completeness: Properly documents all the missing commands that already exist in command_input.go:213-316
  2. Consistency: Follows the existing pattern for command documentation with proper formatting
  3. Accuracy: Command descriptions match their actual implementations:
    • :q → calls tea.Quit (line 223-225 in command_input.go)
    • :login / :login <name> → executes AWS console login (line 244-258)
    • :theme <name> → triggers theme change (line 296-303)
    • :autosave → toggles config persistence (line 305-316)

📝 Minor Observations

1. Examples Section Cleanup (Lines 155-162)

  • Removed the :sort desc Age example and replaced it with new command examples
  • This is a reasonable trade-off, though sorting examples are still present at line 157
  • The new examples (:login, :theme nord) are more user-facing and valuable for discovery

2. Documentation Placement

  • Commands are added in the "Command Mode" section (lines 105-109), which is the correct location
  • Maintains good separation between interactive keybindings and colon commands

🔍 Potential Improvements (Optional)

  1. :autosave parameter clarification: The description says "Toggle config persistence (on/off)" but based on command_input.go:305-316, it requires an explicit parameter. Consider clarifying to :autosave <on|off> to better match the actual command signature like :login <name> does.

  2. :q vs q keybinding: Both are documented (line 71 shows q keybinding, line 105 shows :q command). While both work (different code paths), users might wonder about the difference. This is fine as-is but worth noting for documentation clarity.

🧪 Test Coverage

  • help_view_test.go has minimal tests (only checks for nil and non-empty status)
  • Recommendation: Consider adding a test that verifies the rendered content contains these new commands to prevent regression during future refactoring

🎯 Recommendation

Approve with optional minor enhancement: The PR is well-implemented and ready to merge. The only suggestion is to clarify the :autosave parameter requirement to match the implementation.


Overall Assessment: This is a clean documentation improvement that enhances user experience by making existing features more discoverable. The code quality is good, follows existing patterns, and the changes are low-risk.

@yimsk yimsk merged commit 218e862 into main Jan 5, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant