Skip to content

refactor(docs): reorganize quote/trade/market sidebar structure #1001

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
huacnlee merged 4 commits into from
May 17, 2026
Merged

refactor(docs): reorganize quote/trade/market sidebar structure #1001

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
739c23f
refactor(docs): reorganize quote/trade sidebar structure
huacnlee May 17, 2026
2afbddd
.
huacnlee May 17, 2026
e4f079a
.
huacnlee May 17, 2026
01aee52
.
huacnlee May 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions docs/.vitepress/locales/en/sidebar.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,7 @@ function buildDocsSidebar(): DefaultTheme.SidebarItem[] {
const link = typeof item.link === 'string' ? item.link : ''
return !link.endsWith('/mcp') && !link.endsWith('/docs/api')
})
const llmIdx = items.findIndex((item) => typeof item.link === 'string' && item.link.endsWith('/llm'))
if (llmIdx !== -1) {
items.splice(llmIdx + 1, 0, apiRefItem)
} else {
items.push(apiRefItem)
}
items.push(apiRefItem)
return items
}

Expand Down
7 changes: 1 addition & 6 deletions docs/.vitepress/locales/zh-CN/sidebar.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,7 @@ function buildDocsSidebar(): DefaultTheme.SidebarItem[] {
const link = typeof item.link === 'string' ? item.link : ''
return !link.endsWith('/mcp') && !link.endsWith('/docs/api')
})
const llmIdx = items.findIndex((item) => typeof item.link === 'string' && item.link.endsWith('/llm'))
if (llmIdx !== -1) {
items.splice(llmIdx + 1, 0, apiRefItem)
} else {
items.push(apiRefItem)
}
items.push(apiRefItem)
return items
}

Expand Down
7 changes: 1 addition & 6 deletions docs/.vitepress/locales/zh-HK/sidebar.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,7 @@ function buildDocsSidebar(): DefaultTheme.SidebarItem[] {
const link = typeof item.link === 'string' ? item.link : ''
return !link.endsWith('/mcp') && !link.endsWith('/docs/api')
})
const llmIdx = items.findIndex((item) => typeof item.link === 'string' && item.link.endsWith('/llm'))
if (llmIdx !== -1) {
items.splice(llmIdx + 1, 0, apiRefItem)
} else {
items.push(apiRefItem)
}
items.push(apiRefItem)
return items
}

Expand Down
1 change: 1 addition & 0 deletions docs/.vitepress/theme/style/index.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ html:root {
margin: 16px 0 20px;
border-radius: 8px;
overflow: hidden;
border: 1px solid var(--vp-code-block-divider-color, rgba(128, 128, 128, 0.15));
}

.vp-cli-command div[class*='language-'].vp-adaptive-theme {
Expand Down
1 change: 1 addition & 0 deletions docs/en/docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ layout: api-reference
title: API Reference
sidebar: false
sidebar_icon: book
sidebar_position: 7
---
7 changes: 0 additions & 7 deletions docs/en/docs/fundamental/calendar/_category_.json
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion docs/en/docs/fundamental/market/_category_.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"position": 2,
"label": "Market",
"label": "Market Data",
"collapsible": true,
"collapsed": true,
"link": null
Expand Down
1 change: 0 additions & 1 deletion docs/en/docs/fundamental/market/index_components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
slug: index-components
title: Index Components
sidebar_position: 6
language_tabs: false
toc_footers: []
includes: []
Expand Down
7 changes: 7 additions & 0 deletions docs/en/docs/market/_category_.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"label": "Market",
"collapsible": true,
"collapsed": true,
"link": null,
"position": 3.7
}
4 changes: 2 additions & 2 deletions docs/en/docs/quote/security/_category_.json → docs/en/docs/market/calendar/_category_.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"label": "Security",
"label": "Financial Calendar",
"collapsible": true,
"collapsed": true,
"link": null,
"position": 6
}
}
2 changes: 1 addition & 1 deletion ...fundamental/calendar/dividend_calendar.md → ...docs/market/calendar/dividend_calendar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: dividend-calendar
slug: /market/calendar/dividend-calendar
title: Dividend Calendar
sidebar_position: 2
language_tabs: false
Expand Down
2 changes: 1 addition & 1 deletion ...fundamental/calendar/earnings_calendar.md → ...docs/market/calendar/earnings_calendar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: earnings-calendar
slug: /market/calendar/earnings-calendar
title: Earnings Calendar
sidebar_position: 1
language_tabs: false
Expand Down
2 changes: 1 addition & 1 deletion ...docs/fundamental/calendar/ipo_calendar.md → docs/en/docs/market/calendar/ipo_calendar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: ipo-calendar
slug: /market/calendar/ipo-calendar
title: IPO Calendar
sidebar_position: 4
language_tabs: false
Expand Down
2 changes: 1 addition & 1 deletion ...cs/fundamental/calendar/macro_calendar.md → ...en/docs/market/calendar/macro_calendar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: macro-calendar
slug: /market/calendar/macro-calendar
title: Macro Calendar
sidebar_position: 5
language_tabs: false
Expand Down
2 changes: 1 addition & 1 deletion .../fundamental/calendar/meeting_calendar.md → .../docs/market/calendar/meeting_calendar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: meeting-calendar
slug: /market/calendar/meeting-calendar
title: Meeting Calendar
sidebar_position: 6
language_tabs: false
Expand Down
2 changes: 1 addition & 1 deletion ...cs/fundamental/calendar/merge_calendar.md → ...en/docs/market/calendar/merge_calendar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: merge-calendar
slug: /market/calendar/merge-calendar
title: Merge Calendar
sidebar_position: 7
language_tabs: false
Expand Down
2 changes: 1 addition & 1 deletion ...cs/fundamental/calendar/split_calendar.md → ...en/docs/market/calendar/split_calendar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: split-calendar
slug: /market/calendar/split-calendar
title: Split Calendar
sidebar_position: 3
language_tabs: false
Expand Down
7 changes: 7 additions & 0 deletions docs/en/docs/market/status/_category_.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"label": "Market Status",
"collapsible": true,
"collapsed": true,
"link": null,
"position": 4
}
6 changes: 3 additions & 3 deletions ...en/docs/quote/pull/history-market-temp.md → ...docs/market/status/history-market-temp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Historical Market Temperature
slug: history_market_temperature
sidebar_position: 22
title: Historical Temperature
slug: /market/history-market-temperature
sidebar_position: 3
---

This interface is used to get historical market temperature.
Expand Down
6 changes: 3 additions & 3 deletions docs/en/docs/quote/pull/market-temp.md → docs/en/docs/market/status/market-temp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Current Market Temperature
slug: market_temperature
sidebar_position: 21
title: Market Temperature
slug: /market/market-temperature
sidebar_position: 2
---

Get Current Market Temperature
Expand Down
2 changes: 1 addition & 1 deletion .../docs/fundamental/market/market_status.md → docs/en/docs/market/status/market_status.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: market-status
slug: /market/market-status
title: Market Status
sidebar_position: 1
language_tabs: false
Expand Down
6 changes: 3 additions & 3 deletions docs/en/docs/quote/pull/trade-day.md → docs/en/docs/market/status/trade-day.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
id: quote_trade_day
title: Market Trading Days
slug: trade-day
sidebar_position: 16
title: Trading Days
slug: /market/trade-days
sidebar_position: 6
---

This API is used to obtain the trading days of the market.
Expand Down
6 changes: 3 additions & 3 deletions docs/en/docs/quote/pull/trade-session.md → docs/en/docs/market/status/trade-session.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
id: quote_trade_session
title: Trading Session of The Day
slug: trade-session
sidebar_position: 15
title: Trading Sessions
slug: /market/trade-session
sidebar_position: 4
---

This API is used to obtain the daily trading hours of each market.
Expand Down
2 changes: 1 addition & 1 deletion .../docs/fundamental/market/unusual_items.md → docs/en/docs/market/status/unusual_items.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: unusual-items
slug: /market/unusual-items
title: Unusual Items
sidebar_position: 5
language_tabs: false
Expand Down
7 changes: 7 additions & 0 deletions docs/en/docs/quote/analytics/_category_.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"label": "Analytics",
"collapsible": true,
"collapsed": true,
"link": null,
"position": 7
}
90 changes: 45 additions & 45 deletions docs/en/docs/quote/pull/calc-index.md → docs/en/docs/quote/analytics/calc-index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: quote_calc_index.md
title: Calculate Indexes Of Securities
slug: calc-index
title: Calc Index
slug: /quote/pull/calc-index
sidebar_position: 19
---

Expand Down Expand Up @@ -242,49 +242,49 @@ func main() {

### Response Properties

| Name | Type | Description |
| -------------------------- | -------- | ---------------------------------------------------------------------------------------- |
| security_calc_index | object[] | Security Index Data |
| ∟ symbol | string | Security code |
| ∟ last_done | string | Latest price |
| ∟ change_val | string | Change value |
| ∟ change_rate | string | Change ratio (This field is a ratio field, not include symbol `%`) |
| ∟ volume | int64 | Volume |
| ∟ turnover | string | Turnover |
| ∟ ytd_change_rate | string | Year-to-date change ratio (This field is a ratio field, not include symbol `%`) |
| ∟ turnover_rate | string | Turnover rate (This field is a ratio field, not include symbol `%`) |
| ∟ total_market_value | string | Total market value |
| ∟ capital_flow | string | Capital flow |
| ∟ amplitude | string | Amplitude (This field is a ratio field, not include symbol `%`) |
| ∟ volume_ratio | string | Volume ratio |
| ∟ pe_ttm_ratio | string | PE (TTM) |
| ∟ pb_ratio | string | PB |
| ∟ dividend_ratio_ttm | string | Dividend ratio (TTM) |
| ∟ five_day_change_rate | string | Five days change ratio (This field is a ratio field, not include symbol `%`) |
| ∟ ten_day_change_rate | string | Ten days change ratio (This field is a ratio field, not include symbol `%`) |
| ∟ half_year_change_rate | string | Half year change ratio (This field is a ratio field, not include symbol `%`) |
| ∟ five_minutes_change_rate | string | Five minutes change ratio (This field is a ratio field, not include symbol `%`) |
| ∟ expiry_date | string | Expirt date |
| ∟ strike_price | string | Strike price |
| ∟ upper_strike_price | string | Upper bound price |
| ∟ lower_strike_price | string | Lower bound price |
| ∟ outstanding_qty | int64 | Outstanding quantity |
| ∟ outstanding_ratio | string | Outstanding ratio (This field is a ratio field, not include symbol `%`) |
| ∟ premium | string | Premium (This field is a ratio field, not include symbol `%`) |
| ∟ itm_otm | string | In/out of the bound (This field is a ratio field, not include symbol `%`) |
| ∟ implied_volatility | string | Implied volatility (This field is a ratio field, not include symbol `%`) |
| ∟ warrant_delta | string | Warrant delta |
| ∟ call_price | string | Call price |
| ∟ to_call_price | string | Price interval from the call price (This field is a ratio field, not include symbol `%`) |
| ∟ effective_leverage | string | Effective leverage |
| ∟ leverage_ratio | string | Leverage ratio |
| ∟ conversion_ratio | string | Conversion ratio |
| ∟ balance_point | string | Breakeven point |
| ∟ open_interest | int64 | Open interest |
| ∟ delta | string | Delta |
| ∟ gamma | string | Gamma |
| ∟ theta | string | Theta. Raw value needs to be divided by 100 to get the standard per-share per-day value |
| ∟ vega | string | Vega. Raw value needs to be divided by 100 to get the standard per-share per-1%-IV value |
| Name | Type | Description |
| -------------------------- | -------- | ----------------------------------------------------------------------------------------- |
| security_calc_index | object[] | Security Index Data |
| ∟ symbol | string | Security code |
| ∟ last_done | string | Latest price |
| ∟ change_val | string | Change value |
| ∟ change_rate | string | Change ratio (This field is a ratio field, not include symbol `%`) |
| ∟ volume | int64 | Volume |
| ∟ turnover | string | Turnover |
| ∟ ytd_change_rate | string | Year-to-date change ratio (This field is a ratio field, not include symbol `%`) |
| ∟ turnover_rate | string | Turnover rate (This field is a ratio field, not include symbol `%`) |
| ∟ total_market_value | string | Total market value |
| ∟ capital_flow | string | Capital flow |
| ∟ amplitude | string | Amplitude (This field is a ratio field, not include symbol `%`) |
| ∟ volume_ratio | string | Volume ratio |
| ∟ pe_ttm_ratio | string | PE (TTM) |
| ∟ pb_ratio | string | PB |
| ∟ dividend_ratio_ttm | string | Dividend ratio (TTM) |
| ∟ five_day_change_rate | string | Five days change ratio (This field is a ratio field, not include symbol `%`) |
| ∟ ten_day_change_rate | string | Ten days change ratio (This field is a ratio field, not include symbol `%`) |
| ∟ half_year_change_rate | string | Half year change ratio (This field is a ratio field, not include symbol `%`) |
| ∟ five_minutes_change_rate | string | Five minutes change ratio (This field is a ratio field, not include symbol `%`) |
| ∟ expiry_date | string | Expirt date |
| ∟ strike_price | string | Strike price |
| ∟ upper_strike_price | string | Upper bound price |
| ∟ lower_strike_price | string | Lower bound price |
| ∟ outstanding_qty | int64 | Outstanding quantity |
| ∟ outstanding_ratio | string | Outstanding ratio (This field is a ratio field, not include symbol `%`) |
| ∟ premium | string | Premium (This field is a ratio field, not include symbol `%`) |
| ∟ itm_otm | string | In/out of the bound (This field is a ratio field, not include symbol `%`) |
| ∟ implied_volatility | string | Implied volatility (This field is a ratio field, not include symbol `%`) |
| ∟ warrant_delta | string | Warrant delta |
| ∟ call_price | string | Call price |
| ∟ to_call_price | string | Price interval from the call price (This field is a ratio field, not include symbol `%`) |
| ∟ effective_leverage | string | Effective leverage |
| ∟ leverage_ratio | string | Leverage ratio |
| ∟ conversion_ratio | string | Conversion ratio |
| ∟ balance_point | string | Breakeven point |
| ∟ open_interest | int64 | Open interest |
| ∟ delta | string | Delta |
| ∟ gamma | string | Gamma |
| ∟ theta | string | Theta. Raw value needs to be divided by 100 to get the standard per-share per-day value |
| ∟ vega | string | Vega. Raw value needs to be divided by 100 to get the standard per-share per-1%-IV value |
| ∟ rho | string | Rho. Raw value needs to be divided by 100 to get the standard per-share per-1%-rate value |

### Protobuf
Expand Down
4 changes: 2 additions & 2 deletions ...n/docs/quote/pull/capital_distribution.md → ...s/quote/analytics/capital_distribution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: quote_capital_distribution.md
title: Security Capital Distribution
slug: capital-distribution
title: Capital Distribution
slug: /quote/pull/capital-distribution
sidebar_position: 18
---

Expand Down
4 changes: 2 additions & 2 deletions .../docs/quote/pull/capital_flow_intraday.md → .../quote/analytics/capital_flow_intraday.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: quote_capital_flow_intraday
title: Security Capital Flow Intraday
slug: capital-flow-intraday
title: Capital Flow
slug: /quote/pull/capital-flow-intraday
sidebar_position: 17
---

Expand Down
4 changes: 2 additions & 2 deletions docs/en/docs/quote/pull/filings.md → docs/en/docs/quote/analytics/filings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
slug: filings
title: Security Filings
slug: /quote/pull/filings
title: Filings
sidebar_position: 20.5
language_tabs: false
toc_footers: []
Expand Down
Loading
Loading