Skip to content

SEO 团队反馈我们需要给 developers 项目增加一些链接,请根据文档指引来修改,#1091

Open
endless-bot wants to merge 1 commit into
mainfrom
endless/task-25
Open

SEO 团队反馈我们需要给 developers 项目增加一些链接,请根据文档指引来修改,#1091
endless-bot wants to merge 1 commit into
mainfrom
endless/task-25

Conversation

@endless-bot

Copy link
Copy Markdown
Collaborator

🤖 Auto-generated by Endless task #25.

Initiated by: Huacnlee Li Huashun

Background

The SEO team identified a gap in cross-domain link authority between the developer documentation site (open.longbridge.com) and the main consumer app (longbridge.com). Users reading API/CLI/MCP/Skill documentation often do not know the corresponding features available in the Longbridge app — and the absence of links means both sites lose the SEO benefit of mutual cross-domain authority signals.

The team produced a spreadsheet-style brief specifying 12 exact insertion points across three page types: the AI Skill page (/skill/), the MCP documentation (/docs/mcp), and the CLI overview (/docs/cli/). Each entry defines the source text location, the proposed sentence with anchor text in brackets, the target URL, and step-by-step navigation instructions.

All changes must respect the three-locale rule — every page exists in English (docs/en/), Simplified Chinese (docs/zh-CN/), and Traditional Chinese (docs/zh-HK/) and must be kept in sync.

Summary

  • Problem solved: 12 cross-domain links were missing from developer docs pages, reducing page authority and leaving developer-audience users unaware of the corresponding consumer-app features.
  • What was done:
    • docs/en,zh-CN,zh-HK/docs/mcp.md — inserted 4 links each (market data, Longbridge AI, app download, account signup)
    • docs/en,zh-CN,zh-HK/docs/cli/index.md — inserted 1 link each ("real-time market data" → markets page)
    • Skill.vue — 7 template sites switched to v-html; locale data strings updated for en/zh-CN/zh-HK with anchor HTML for 5 link targets
    • McpTools.vue — screener note injected before the screener_* tool cluster via <template v-for> wrapper + v-if boundary detection; CSS added
    • locales/en,zh-CN,zh-HK.json — 3 new i18n keys each for the screener note
    • skill-catalog/en,zh-CN,zh-HK/index.tslongbridge-quote description extended with markets link
  • Why this approach: All insertion points were purely additive (append or wrap existing text). v-html on controlled static strings avoids restructuring the data layer. McpTools screener note uses the existing useI18n() pattern. No schema changes needed.
  • How to verify: Build and open each of /docs/mcp, /docs/cli/, and /skill/ in all three locales; confirm each anchor text resolves to the specified target URL with target="_blank" rel="noreferrer".

Changes

File Change
docs/en/docs/mcp.md Inserted 4 links: market data, Longbridge AI, app download (automation row), account (prerequisites)
docs/zh-CN/docs/mcp.md Same 4 links in Simplified Chinese
docs/zh-HK/docs/mcp.md Same 4 links in Traditional Chinese
docs/en/docs/cli/index.md Linked "real-time market data" → longbridge.com/markets
docs/zh-CN/docs/cli/index.md Linked "实时行情" → longbridge.com/markets
docs/zh-HK/docs/cli/index.md Linked "即時行情" → longbridge.com/markets
docs/.vitepress/theme/components/Skill.vue 7 template v-html switches + locale data string updates (en/zh-CN/zh-HK hero.desc, cases.desc, getstarted.card1.desc, capItems.news[0], demos[0].title, CAP_REFERENCE news, DEMO_SCENARIOS[0].title)
docs/.vitepress/theme/components/McpTools.vue Screener note inserted before first screener_ tool via <template v-for> + v-if; added .mcp-screener-note CSS
docs/.vitepress/theme/locales/en.json Added mcp.screenerNotePrefix/NoteLinkText/NoteSuffix keys
docs/.vitepress/theme/locales/zh-CN.json Same 3 keys in Simplified Chinese
docs/.vitepress/theme/locales/zh-HK.json Same 3 keys in Traditional Chinese
docs/.vitepress/theme/components/skill-catalog/en/index.ts longbridge-quote desc: appended "View live quotes on Longbridge." link
docs/.vitepress/theme/components/skill-catalog/zh-CN/index.ts longbridge-quote desc: appended "查看 Longbridge 实时行情。" link
docs/.vitepress/theme/components/skill-catalog/zh-HK/index.ts longbridge-quote desc: appended "查看 Longbridge 即時行情。" link

Key Decisions

v-html for Skill.vue string data: The locale strings are TypeScript literals, not user-supplied input, so using v-html at the specific render sites that need anchor tags is safe and avoids restructuring the data model. The alternative of wrapping each string in a render function or slot would have required touching many more lines.

McpTools screener note position: The mcp-tools.json data is a flat alphabetical array with no group concept. Injecting a note at the boundary where screener_ items first appear (checking idx === 0 || !filtered[idx-1].name.startsWith('screener_')) is robust against search-filtered views — the note only shows when at least one screener tool is visible and re-appears correctly if filtering isolates the cluster.

Generated by Endless task #25.

Co-authored-by: Huacnlee Li Huashun <huacnlee@longbridge-inc.com>
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