Commit Graph

4 Commits

Author SHA1 Message Date
Endless 89d39f2be1 feat: sync new SDK APIs from openapi to docs site (#962)
## Summary

Syncs new SDK interfaces introduced in openapi to the developers
documentation site, along with a range of docs, UI, and infrastructure
improvements.

## New API Documentation (EN / zh-CN / zh-HK)

### Quote APIs
- `option_volume` — option volume query
- `option_volume_daily` — daily option volume query
- `short_positions` — short position data
- `update_pinned` — update pinned securities

### Fundamental APIs
- **Calendar**: dividend, earnings, IPO, macro, split calendars
- **Fundamental**: company profile, corporate actions, dividends,
executives, financial reports, fund holdings, ratings, shareholders,
valuations
- **Market**: AH premium, broker positions, index components, market
status, trading stats, unusual items

### Account APIs
- **Alert**: create, delete, list, update alerts
- **DCA** (dollar-cost averaging): create, delete, list, update, history
- **Portfolio**: capital flow, exchange rates, profit analysis (by
market, detail, summary)
- **Sharelist**: create, delete, list, update share lists

## UI / Site Improvements

- **Pricing page**: new tri-locale pricing comparison page for market
data subscription tiers; fixes for responsive layout and static QR code
on mobile
- **FeaturesMenu**: mega-menu dropdown in main nav with 9 financial data
product categories; full i18n support
- **Nav**: moved API Reference from top nav to Docs sidebar (opens in
new tab)
- **Homepage visual polish**: neutral color vars on ArchCanvas, distinct
card accent hues, section border delineation, ProductSkill gradient,
flat GetStarted background
- **Quote permission**: added permission notices across CLI docs, API
docs, and API Reference; removed unreliable client-side permission
status detection
- **Mock login toggle**: dev-only panel to simulate login/logout state;
shared reactive `useLoginState` composable

## Docs Updates

- CLI v0.19.2 release notes + updated `finance-calendar` subcommand
examples
- Corrected quote permission names to match Quote Store (pluralization,
Nasdaq Basic rename)
- Updated skill guide to use CLI-first flow
- Fixed missing zh-HK translations

## Bug Fixes

- Fixed UnoCSS build error from arbitrary `font-feature-settings` class
- Added `result.root` null guard in `postcss.config.mjs` to prevent
PostCSS crash
- Fixed home page footer rendering
- Fixed pricing page build dist

🤖 Auto-generated by Endless.

---------

Co-authored-by: 老袁 Yuan Zhanghong <zhanghong.yuan@longbridge-inc.com>
Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Jason Lee <huacnlee@gmail.com>
2026-05-14 18:13:11 +08:00
Jason Lee 7d0022c8d9 docs: Fix CLI pages in cn region. (#883)
## Summary

- Rename `installation.md` → `install.md` in all three locales (en,
zh-CN, zh-HK)
- Update all internal links pointing to `/docs/cli/installation`
- Update sidebar `includes('installation')` matcher
- Add `/docs/cli/index.md` and `/docs/cli/install.md` to cn region
whitelist (`open.longbridge.cn`)

## Test plan

- [ ] Verify `/docs/cli/install` loads correctly
- [ ] Verify `/zh-CN/docs/cli/install` and `/zh-HK/docs/cli/install`
load correctly
- [ ] Verify sidebar Installation link works in all locales
- [ ] Verify `bun run dev:cn` shows `/docs/cli` and `/docs/cli/install`

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-04-10 15:52:46 +08:00
Jason Lee 77c7e128b9 feat(cli): Add cli full commands docs. (#882)
## 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](https://claude.com/claude-code)

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-04-10 15:33:28 +08:00
Jason Lee e61c421395 feat: add CliCommand block with syntax highlighting and multi-example docs (#390)
## Summary

- New markdown-it plugin (`cli-command.ts`) renders `<CliCommand>` tags
as styled code blocks with proper shiki dual-theme color variables
(`--shiki-light` / `--shiki-dark`) for syntax highlighting: longbridge
binary (purple), subcommands (blue), args and inline comments (gray)
- Header changed from compact bar to h2-style title matching SDK Links
section; Install CLI link floats right with no border, pointing to
`/docs/cli`
- Single-line `<CliCommand>content</CliCommand>` tokens (parsed as
paragraph > inline by markdown-it) now correctly handled via Case 2
token splice
- Expanded all non-trade `<CliCommand>` blocks from single-line to
multi-line format with 2–4 real verified examples per command and
locale-aware comments (en / zh-CN / zh-HK) across quote pull, content,
subscribe, security, and watchlist docs

## Test plan

- [ ] Run `bun run dev` and verify CliCommand blocks render with correct
syntax highlighting in light and dark mode
- [ ] Verify h2 title "CLI" appears with Install CLI link on the right
(no border)
- [ ] Verify Install CLI link points to `/docs/cli`
- [ ] Check a few pages across en / zh-CN / zh-HK locales

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-03-27 14:19:36 +08:00