mirror of
https://github.com/longbridge/developers.git
synced 2026-09-19 03:34:09 +08:00
Endless
2fef8dc564
🤖 Auto-generated by Endless task [#38](https://endless.longbridge-inc.com/projects/developers/tasks/38). Initiated by: huacnlee@longbridge-inc.com Worker agent: Kayak (ri · lboneapi · DeepSeek-V3.2) ## Summary - Longbridge Developers lacked a formal documentation content strategy and writing standard, making it difficult to maintain consistency across multilingual docs - Introduces a comprehensive style guide (inspired by Cloudflare's Product docs content strategy) covering content types, API reference standards, information architecture, writing guidelines, and multilingual rules - Adds a product spec (`specs/2026-07-14-content-strategy.md`) capturing the full content strategy design rationale - Removes obsolete `content/overview.md` pages across all three locales (en, zh-CN, zh-HK) and cleans up the sensors utility - Verify by navigating to the `/style-guide/` section in the local dev server and confirming all five guide pages render correctly with sidebar navigation - Cross-check that existing pages (getting-started, CLI, quote APIs) still render without broken links after the nav config updates ## Changes | File | Change | |---|---| | `docs/en/docs/style-guide/index.md` | New style guide landing page (EN) | | `docs/en/docs/style-guide/content-types.md` | New content-types guide defining tutorials, how-tos, reference, and concept pages | | `docs/en/docs/style-guide/api-reference.md` | New API reference writing standard | | `docs/en/docs/style-guide/information-architecture.md` | New IA guidelines for doc structure and navigation | | `docs/en/docs/style-guide/writing-guidelines.md` | New writing style and tone guidelines | | `docs/en/docs/style-guide/multilingual.md` | New multilingual documentation rules | | `docs/en/docs/style-guide/_category_.json` | Sidebar category metadata for style guide section | | `specs/2026-07-14-content-strategy.md` | Full product spec for the content strategy initiative | | `docs/.vitepress/config.mts` | Added style guide section to VitePress site config | | `docs/.vitepress/locales/en/index.ts` | Updated EN locale nav/sidebar to include style guide | | `docs/.vitepress/locales/zh-CN/index.ts` | Updated zh-CN locale nav/sidebar | | `docs/.vitepress/locales/zh-HK/index.ts` | Updated zh-HK locale nav/sidebar | | `docs/.vitepress/theme/utils/sensors.ts` | Removed unused analytics sensors utility | | `docs/.vitepress/theme/index.ts` | Cleaned up theme entry, removed sensors import | | `docs/.vitepress/theme/components/NewHomePage/index.vue` | Minor homepage component cleanup | | `docs/.vitepress/theme/components/Pricing.vue` | Minor pricing component cleanup | | `docs/.vitepress/theme/components/Skill.vue` | Minor skill component cleanup | | `docs/en/docs/content/overview.md` | Removed obsolete content overview page (EN) | | `docs/zh-CN/docs/content/overview.md` | Removed obsolete content overview page (zh-CN) | | `docs/zh-HK/docs/content/overview.md` | Removed obsolete content overview page (zh-HK) | | `docs/en/docs/quote/stocks/history-candlestick.md` | Updated candlestick doc formatting/content | | `docs/zh-CN/docs/quote/stocks/history-candlestick.md` | Updated candlestick doc formatting/content (zh-CN) | | `docs/zh-HK/docs/quote/stocks/history-candlestick.md` | Updated candlestick doc formatting/content (zh-HK) | | `docs/en/docs/quote/stocks/quote.md` | Minor fix to quote doc | | `docs/zh-CN/docs/quote/stocks/quote.md` | Minor fix to quote doc (zh-CN) | | `docs/zh-HK/docs/quote/stocks/quote.md` | Minor fix to quote doc (zh-HK) | | `docs/en/docs/getting-started.md` | Minor fix to getting started doc --------- Co-authored-by: Huacnlee Li Huashun <huacnlee@longbridge-inc.com> Co-authored-by: Jason Lee <huacnlee@gmail.com> Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>