Skip to content

fix(docs): fix broken error-codes link and remove Chinese text from English pages - #1296

Merged
hogan-yuan merged 2 commits into
mainfrom
fix/api-error-codes-link
Oct 22, 2026
Merged

hogan-yuan merged 2 commits into
mainfrom
fix/api-error-codes-link

Conversation

@hogan-yuan

@hogan-yuan hogan-yuan commented Oct 22, 2026 •

Copy link
Copy Markdown
Member

What changed

Broken Error Codes link

  • The "Error Codes" link on every API Reference endpoint page (e.g. /docs/api/list_news) and in the Overview page pointed to /docs/error-codes, which 404s. It now opens the API Reference error codes page (/docs/api?page=error-codes), with the locale prefix preserved.

Chinese text on English pages

  • Replaced full-width punctuation (, :) in English prose, tables and sequence diagrams (socket protocol pages, option chain, trade definitions, changelog, etc.).
  • The Real-Time Market Data page now references the English sidebar groups (Quote → …, Trade → …) instead of 行情 / 交易.
  • English code examples (and the shared response examples in openapi.yaml) now use English values, such as rank categories, top-movers reasons and labels, screener indicators and strategies, IPO names, sharelists, fundamentals and alerts. Values are taken from longbridge --lang en output where available.
  • Fields that are localized by design (name_cn, name_hk, participant_name_cn, *_zhcn) keep their Chinese values.

🤖 Generated with Claude Code

…-codes page

/docs/error-codes does not exist; the error codes live in the x-pages
topic rendered at /docs/api?page=error-codes.
- Replace full-width punctuation (, :) in English prose, tables and diagrams
- Use English sidebar group names in the Real-Time Market Data page
- Translate Chinese values in English code examples and shared openapi.yaml
  response examples, using CLI --lang en output where available; keep
  explicitly localized fields (name_cn, name_hk, *_zhcn) unchanged
@hogan-yuan
hogan-yuan merged commit 59eeb83 into main Oct 22, 2026
2 checks passed
@hogan-yuan
hogan-yuan deleted the fix/api-error-codes-link branch October 22, 2026 08:33
hogan-yuan added a commit that referenced this pull request Oct 23, 2026
## What changed

Fixed three links that returned 404:

- **Agent Auth Code** links on `/docs/cli/install` and `/docs/mcp`
pointed to `/agent-auth`; they now go to `/docs/agent-auth`.
- **MCP authorization flow** link on `/docs/agent-auth` pointed to
`/mcp`; it now goes to `/docs/mcp`.
- **Candlestick - Pull** link on the candlestick push page
(`/docs/quote/push/candlestick`) pointed to `/quote/stocks/candlestick`;
it now goes to `/docs/quote/pull/candlestick` (with the `/zh-CN` /
`/zh-HK` prefix on the Chinese pages).

The `/docs/error-codes` link at the bottom of API Reference pages was
already fixed in #1296.

🤖 Generated with [Claude Code](https://claude.com/claude-code)
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