Skip to content

docs: add missing commands to help view#107

Merged
yimsk merged 1 commit intodevelopfrom
feature/update-help-commands
Jan 5, 2026
Merged

docs: add missing commands to help view#107
yimsk merged 1 commit intodevelopfrom
feature/update-help-commands

Conversation

@yimsk
Copy link
Copy Markdown
Contributor

@yimsk yimsk commented Jan 5, 2026

Summary

  • Add :login, :theme, :autosave, :q to help view Command Mode section
  • Update Command Examples with login/theme examples

Closes #N/A (housekeeping)

@claude
Copy link
Copy Markdown

claude Bot commented Jan 5, 2026

PR Review: docs: add missing commands to help view

Summary

This PR adds documentation for several command mode commands (:login, :theme, :autosave, :q) that were missing from the help view, and updates the command examples section. The changes are straightforward and improve the discoverability of these features.

Code Quality ✅

  • Clean and consistent: The changes follow the existing code structure and formatting patterns
  • Proper placement: New command documentation is logically placed in the "Command Mode" section alongside other command-mode keybindings
  • Consistent style: Uses the same s.key.Render() and s.desc.Render() pattern as existing entries

Verification ✅

I verified that all documented commands exist in the codebase:

  • :q - Implemented at internal/view/command_input.go:223
  • :login - Implemented at internal/view/command_input.go:244-258
  • :theme - Implemented at internal/view/command_input.go:296-303
  • :autosave - Implemented at internal/view/command_input.go:305-313

Observations

Positive aspects:

  1. Improves user experience by documenting previously undocumented commands
  2. The :login descriptions accurately reflect the implementation (default profile is "claws-login")
  3. Command examples section was improved by replacing less useful examples with more practical ones

Minor inconsistencies noted (not blockers):

  1. Line 157: Removed the :sort desc Age example - this is fine as it simplifies the examples, but users may want to know about the descending sort option
  2. The help view already shows q as a quit key in the Navigation section (line 71), and now :q is also shown - this redundancy is acceptable as they're different methods to quit

Test Coverage ⚠️

The existing test file (internal/view/help_view_test.go) only has basic tests for creating the view and checking the status line. Consider adding a test that verifies all documented commands in the help text actually have corresponding implementations. However, this is not a blocker for this PR since:

  • This is a documentation-only change
  • All commands were manually verified to exist
  • The existing test coverage is minimal throughout

Performance Considerations ✅

  • No performance impact - only adds a few string literals to the rendered content

Security Concerns ✅

  • No security concerns - purely display/documentation changes

Recommendations

  1. Approve and merge - This is a good documentation improvement
  2. 💡 Optional follow-up: Consider documenting the desc option for the :sort command somewhere, since the example was removed
  3. 💡 Optional follow-up: Add integration tests that verify help documentation matches actual command implementations to prevent drift

Verdict

LGTM - Ready to merge! 🚀

This is a clean, well-executed documentation improvement that makes the application more user-friendly. The changes are accurate, consistent with the existing codebase, and enhance feature discoverability.

@yimsk yimsk merged commit bcd54a1 into develop Jan 5, 2026
5 checks passed
@yimsk yimsk deleted the feature/update-help-commands branch January 5, 2026 09:18
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