Skip to content

feat(cli): Add cli full commands docs.#882

Merged
huacnlee merged 48 commits intomainfrom
cli-channel
Apr 10, 2026
Merged

feat(cli): Add cli full commands docs.#882
huacnlee merged 48 commits intomainfrom
cli-channel

Conversation

@huacnlee
Copy link
Copy Markdown
Member

Summary

  • Add github icon SVG to SIDEBAR_ICONS in gen.ts
  • Export SIDEBAR_ICONS_MAP for use in sidebar configs
  • Fix zh-CN/zh-HK sidebar link generation to include locale prefix (fixes link doubling bug)
  • Inject GitHub repo link after Installation item in CLI sidebar for all three locales (en, zh-CN, zh-HK)

Test plan

  • Verify CLI sidebar shows: Overview → Installation → GitHub (with icon) → Market Data → ...
  • Verify GitHub link works and opens https://github.com/longbridge/longbridge-terminal
  • Verify zh-CN and zh-HK CLI sidebar links are correct (no doubling)

🤖 Generated with Claude Code

huacnlee and others added 30 commits April 10, 2026 10:53
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…-CN/zh-HK CLI stubs

- Fix sidebar trailing slash bug: `/docs/` key didn't match `/docs` index path in VitePress
  startsWith matching; changed to `/docs` (and zh-CN/zh-HK equivalents)
- Rename setup.md → installation.md; add full install guide (platform tabs + login/check/update/logout)
- Remove --headless flag from login (removed in v0.14.0)
- Move tui.md to end of sidebar (position 99, before release-notes at 100)
- Create zh-CN/zh-HK CLI index.md and installation.md stubs to fix nav 404

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Add real command output examples after the Basic Usage section for all
remaining CLI pages: capital, orders (order, exchange-rate, margin-ratio,
max-qty), account (assets, portfolio, positions, cash-flow, fund-holder,
fund-positions), and research (insider-trades, investors, shareholder).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…pages

Replace Chinese text in output examples with English equivalents for
financial-report, dividend, consensus, valuation, and finance-calendar pages.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
huacnlee and others added 16 commits April 10, 2026 13:35
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…nces

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…tchlist/content last; rename TUI label

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
… asciinema on TUI

- gen.ts: add icon support to _category_.json + 8 new Lucide icons
- CLI sidebar groups: bar-chart-2, layers, book-open, search, briefcase, arrow-right-left, star, newspaper
- installation.md: link to longbridge/longbridge-terminal GitHub (new tab)
- tui.md: embed asciinema recording

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add CLI_COMMAND_MAP mapping subcommand names to doc page paths
- Extract first longbridge command from block to determine usage URL
- Show "Usage | Install" links when a matching page is found
- Update install URL from /docs/cli to /docs/cli/installation
- Rename install label from "Install CLI" to "Install"
- Add vp-cli-links, vp-cli-usage-link, vp-cli-link-sep CSS classes

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…mand parity

- Add icon field to _category_.json for quote/trade/content/socket/qa in all 3 locales
- Convert 52 en docs bash blocks with longbridge commands to <CliCommand>
- Redesign CliCommand header: terminal icon + "CLI" badge, icon-only action buttons
- Replace h2/text-links with compact header + book/download icon buttons (with tooltips)
- Hide redundant "bash" lang label within CLI blocks

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Fix create_topic.md TipContainer tag corrupted by batch conversion
- Fix CliCommand CSS: add overflow:hidden/box-shadow to container,
  reset box-shadow/padding/radius on inner code block (same pattern
  as vp-code-group) so header and code block connect visually

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- CliCommand usage links now point to en (root) pages, zh-CN/zh-HK
  CLI subcommand pages don't exist yet so locale-prefixed links 404
- Replace Trade sidebar icon: arrow-right-left → trending-up
- Add trending-up SVG to SIDEBAR_ICONS

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Translate all CLI subcommand pages (market-data, orders, account,
  content, derivatives, fundamentals, research, watchlist) to zh-CN
- Convert zh-CN to zh-HK (Traditional Chinese) for all pages
- Add _category_.json with localized labels for all subdirectories
- Add tui.md and release-notes.md for both zh-CN and zh-HK
- Add sidebar_icon (terminal/cpu) to CLI index/installation pages

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add github icon SVG to SIDEBAR_ICONS in gen.ts
- Export SIDEBAR_ICONS_MAP for use in sidebar configs
- Fix zh-CN/zh-HK sidebar link generation to include locale prefix
- Inject GitHub repo link after Installation item in all three locales

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
All internal links in zh-CN CLI docs were pointing to /docs/quote/
and /docs/trade/ (en locale paths) instead of /zh-CN/docs/quote/
and /zh-CN/docs/trade/.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@huacnlee huacnlee changed the title feat(cli): add GitHub link to CLI sidebar with icon feat(cli): Add cli full commands docs. Apr 10, 2026
huacnlee and others added 2 commits April 10, 2026 15:30
- Replace "LLMs Text" label with file-text icon + "Markdown" label
- Change "Edit this page" to "Edit" for brevity
- Align both footer links to same color and font-weight

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@huacnlee huacnlee merged commit 77c7e12 into main Apr 10, 2026
2 checks passed
@huacnlee huacnlee deleted the cli-channel branch April 10, 2026 07:33
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