1  # Cross-Reference Configuration
  2  # This file defines the relationships and mappings for automatic cross-referencing
  3  
  4  # Concept to link mappings
  5  concept_links:
  6    # Core concepts
  7    strategy: "../guides/strategy-development.md"
  8    strategies: "../guides/strategy-development.md"
  9    backtest: "../guides/execution-modes.md#simulation-mode"
 10    backtesting: "../guides/execution-modes.md#simulation-mode"
 11    paper trading: "../guides/execution-modes.md#paper-mode"
 12    live trading: "../guides/execution-modes.md#live-mode"
 13    simulation: "../guides/execution-modes.md#simulation-mode"
 14    optimization: "../optimization.md"
 15    parameter optimization: "../optimization.md"
 16    
 17    # Technical concepts
 18    OHLCV: "../guides/data-management.md#ohlcv-data"
 19    OHLCV data: "../guides/data-management.md#ohlcv-data"
 20    market data: "../guides/data-management.md"
 21    data management: "../guides/data-management.md"
 22    timeframe: "../guides/data-management.md#timeframes"
 23    timeframes: "../guides/data-management.md#timeframes"
 24    
 25    # Exchange concepts
 26    exchange: "../exchanges.md"
 27    exchanges: "../exchanges.md"
 28    CCXT: "../exchanges.md#ccxt-integration"
 29    API keys: "../getting-started/installation.md#api-configuration"
 30    
 31    # Margin trading
 32    margin trading: "../guides/strategy-development.md#margin-trading-concepts"
 33    leverage: "../guides/strategy-development.md#margin-modes"
 34    isolated margin: "../guides/strategy-development.md#margin-modes"
 35    cross margin: "../guides/strategy-development.md#margin-modes"
 36    
 37    # Technical indicators
 38    RSI: "../guides/strategy-development.md#technical-indicators"
 39    moving average: "../guides/strategy-development.md#technical-indicators"
 40    technical indicators: "../guides/strategy-development.md#technical-indicators"
 41    
 42    # Configuration
 43    configuration: "../config.md"
 44    planar.toml: "../config.md#configuration-file"
 45    secrets.toml: "../config.md#secrets-management"
 46    
 47    # Troubleshooting
 48    troubleshooting: "../troubleshooting/"
 49    installation issues: "../troubleshooting/installation-issues.md"
 50    performance issues: "../troubleshooting/performance-issues.md"
 51    
 52    # Julia concepts
 53    Julia: "https://julialang.org/"
 54    dispatch system: "../guides/strategy-development.md#dispatch-system"
 55    multiple dispatch: "../guides/strategy-development.md#dispatch-system"
 56  
 57  # Topic categories for automatic tagging
 58  topic_categories:
 59    getting-started:
 60      - installation
 61      - quick-start
 62      - first-strategy
 63      - tutorial
 64      - beginner
 65      
 66    strategy-development:
 67      - strategy
 68      - trading-logic
 69      - indicators
 70      - signals
 71      - call!
 72      - dispatch
 73      
 74    data-management:
 75      - ohlcv
 76      - market-data
 77      - timeframes
 78      - storage
 79      - zarr
 80      - fetch
 81      
 82    execution-modes:
 83      - simulation
 84      - paper-trading
 85      - live-trading
 86      - backtesting
 87      - sim-mode
 88      - paper-mode
 89      - live-mode
 90      
 91    exchanges:
 92      - ccxt
 93      - api
 94      - binance
 95      - bybit
 96      - kucoin
 97      - exchange
 98      
 99    optimization:
100      - parameters
101      - grid-search
102      - bayesian
103      - performance
104      - optim
105      
106    margin-trading:
107      - leverage
108      - isolated
109      - cross
110      - positions
111      - margin
112      
113    troubleshooting:
114      - errors
115      - debugging
116      - performance
117      - installation
118      - problems
119      
120    configuration:
121      - settings
122      - toml
123      - secrets
124      - environment
125      - config
126      
127    visualization:
128      - plotting
129      - charts
130      - analysis
131      - metrics
132      - balloons
133  
134  # Related content mappings (bidirectional)
135  related_content:
136    getting-started/installation.md:
137      - getting-started/quick-start.md
138      - getting-started/first-strategy.md
139      - troubleshooting/installation-issues.md
140      - config.md
141      
142    getting-started/quick-start.md:
143      - getting-started/installation.md
144      - getting-started/first-strategy.md
145      - guides/strategy-development.md
146      - guides/data-management.md
147      
148    getting-started/first-strategy.md:
149      - getting-started/quick-start.md
150      - guides/strategy-development.md
151      - guides/data-management.md
152      - optimization.md
153      
154    guides/strategy-development.md:
155      - guides/data-management.md
156      - guides/execution-modes.md
157      - optimization.md
158      - reference/api/
159      - troubleshooting/strategy-problems.md
160      
161    guides/data-management.md:
162      - guides/strategy-development.md
163      - exchanges.md
164      - troubleshooting/performance-issues.md
165      - config.md
166      
167    guides/execution-modes.md:
168      - guides/strategy-development.md
169      - engine/
170      - troubleshooting/strategy-problems.md
171      - config.md
172      
173    optimization.md:
174      - guides/strategy-development.md
175      - troubleshooting/performance-issues.md
176      - reference/api/
177      
178    exchanges.md:
179      - guides/data-management.md
180      - config.md
181      - troubleshooting/exchange-issues.md
182      
183    config.md:
184      - getting-started/installation.md
185      - guides/strategy-development.md
186      - troubleshooting/
187      
188    troubleshooting/index.md:
189      - troubleshooting/installation-issues.md
190      - troubleshooting/strategy-problems.md
191      - troubleshooting/performance-issues.md
192      - troubleshooting/exchange-issues.md
193  
194  # File descriptions for "See Also" sections
195  file_descriptions:
196    installation.md: "Setup and installation guide"
197    quick-start.md: "15-minute getting started tutorial"
198    first-strategy.md: "Build your first trading strategy"
199    strategy-development.md: "Complete strategy development guide"
200    data-management.md: "Working with market data"
201    execution-modes.md: "Simulation, paper, and live trading"
202    optimization.md: "Parameter optimization techniques"
203    exchanges.md: "Exchange integration and configuration"
204    config.md: "Configuration and settings"
205    troubleshooting.md: "Problem resolution and debugging"
206  
207  # Hover tooltip definitions (for future implementation)
208  tooltips:
209    strategy: "A Julia module that defines trading logic through call! methods"
210    OHLCV: "Open, High, Low, Close, Volume - basic market data format"
211    backtest: "Running a strategy against historical data to evaluate performance"
212    dispatch: "Julia's method selection based on argument types"
213    leverage: "Using borrowed capital to increase position size"
214    timeframe: "Time interval for market data (e.g., 1m, 5m, 1h, 1d)"