diff --git a/.autocorrectignore b/.autocorrectignore new file mode 100644 index 00000000..a94b5b51 --- /dev/null +++ b/.autocorrectignore @@ -0,0 +1 @@ +skills.json diff --git a/.impeccable.md b/.impeccable.md deleted file mode 100644 index 5b65cbe7..00000000 --- a/.impeccable.md +++ /dev/null @@ -1,21 +0,0 @@ -## Design Context - -### Users -Mixed audience: professional fintech developers (quant trading, algo trading), individual investors building tools, AI developers integrating via MCP/Skill, and students exploring financial APIs. They use the site during working hours at desks — browsing docs, copying code, configuring SDKs. The core job: integrate real-time market data and trading into their applications as fast as possible. - -### Brand Personality -**Clear, concise, serious.** The interface should feel like a reliable financial infrastructure provider — not flashy, not playful, but genuinely trustworthy. Users are entrusting real money to this API. The tone is confident without being corporate-stiff. Think: a well-organized engineering handbook, not a marketing landing page. - -### Aesthetic Direction -- **Reference**: Stripe Docs, Vercel Docs — clean developer documentation with code-first presentation, clear navigation, generous whitespace -- **Anti-reference**: Generic fintech dashboards with gratuitous charts, dark-mode-everything with neon glows, over-animated marketing pages -- **Theme**: Light mode primary (docs browsing context), dark mode supported -- **Brand color**: `#00b8b8` (teal/cyan) — used sparingly as accent, not splashed everywhere -- **Typography**: Current system uses Inter — functional but generic. Body text needs to be highly readable at small sizes for docs/code contexts - -### Design Principles -1. **Content density over decoration** — Every pixel should serve information delivery. Remove ornament that doesn't help users find what they need. -2. **Code is the hero** — SDK examples, CLI commands, API responses should be the visual centerpiece, not marketing copy or illustrations. -3. **Trust through clarity** — Financial platforms earn trust by being predictable and well-organized, not by looking expensive. Clear hierarchy, consistent patterns, no surprises. -4. **Progressive complexity** — Surface simple getting-started paths first. Let advanced capabilities (WebSocket protocols, order types, rate limits) reveal themselves through exploration, not upfront bombardment. -5. **Respect the developer's time** — Fast page loads, scannable layouts, copy-paste ready code blocks. Every interaction should feel like it saves time, not wastes it. diff --git a/docs/.vitepress/theme/components/Skill.vue b/docs/.vitepress/theme/components/Skill.vue index 05ccf4e2..662c71e2 100644 --- a/docs/.vitepress/theme/components/Skill.vue +++ b/docs/.vitepress/theme/components/Skill.vue @@ -4,9 +4,13 @@ import { useData } from 'vitepress' import AppNav from './AppNav.vue' import AppFooter from './AppFooter.vue' import type { SkillEntry } from './skill-catalog/types' -import { locale as enLocale } from './skill-catalog/en' -import { locale as zhCNLocale } from './skill-catalog/zh-CN' -import { locale as zhHKLocale } from './skill-catalog/zh-HK' +import { augmentLocale } from './skill-catalog/augment' +import { locale as _enLocale } from './skill-catalog/en' +import { locale as _zhCNLocale } from './skill-catalog/zh-CN' +import { locale as _zhHKLocale } from './skill-catalog/zh-HK' +const enLocale = augmentLocale(_enLocale) +const zhCNLocale = augmentLocale(_zhCNLocale) +const zhHKLocale = augmentLocale(_zhHKLocale) const { lang } = useData() @@ -559,6 +563,7 @@ const SKILLS = [ id: 'longbridge', name: 'Longbridge Overview', cat: 'Platform', + tag: 'Popular', desc: 'Full-stack financial data and trading platform — CLI, Python/Rust SDK, MCP, and LLM integration.', example: "What is NVDA's current price, recent news, and how does it affect my positions?", }, @@ -1538,7 +1543,6 @@ function triggerRipple(event: MouseEvent, el: HTMLElement) {
{{ skill.desc }}