Skip to content

docs(readme): polish for users and refresh for v2.9 - #124

Merged
GOODBOY008 merged 1 commit into
mainfrom
docs/polish-readme
Sep 1, 2026
Merged

docs(readme): polish for users and refresh for v2.9#124
GOODBOY008 merged 1 commit into
mainfrom
docs/polish-readme

Conversation

@GOODBOY008

Copy link
Copy Markdown
Owner

Summary

  • Remove the Star History section and development-facing content (Development, Project Structure sections and their nav link) so the README reads user-focused
  • Refresh facts against the current codebase: xterm.js 6, 45+ UI primitives, corrected keyboard shortcut table (Ctrl+W close tab, Ctrl+Shift+Tab, Ctrl+A, D detach)
  • Document recent features: SSH tunnel (jump host), Quick Commands panel, session detach, launch at login, built-in code editor, config backup, i18n (en/zh-CN), layout persistence, close-all tabs, batch delete
  • Move Installation above Tech Stack and fix section anchors

Test plan

  • Verified every updated claim against source (package.json, settings-modal.tsx, keyboard-shortcuts.ts, pty-terminal.tsx, quick-commands-panel.tsx, locales/)
  • Grep confirms no leftover references to removed sections or stale facts
  • Review rendered README on GitHub (anchors, badges, screenshot)

Remove Star History and development-facing sections (Development,
Project Structure) and update facts against the current codebase:
SSH tunnel/jump host, Quick Commands panel, session detach, launch
at login, built-in code editor, config backup, i18n, xterm.js 6,
and corrected keyboard shortcut table.
Copilot AI lite review requested due to automatic review settings August 31, 2026 16:01

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@GOODBOY008
GOODBOY008 merged commit 69e7a19 into main Sep 1, 2026
4 checks passed
@GOODBOY008
GOODBOY008 deleted the docs/polish-readme branch September 1, 2026 01:19
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.

2 participants