navigation.yml
1 # Planar Documentation Navigation Configuration 2 # This file defines the structure and organization of the documentation 3 4 site: 5 title: "Planar Documentation" 6 description: "Advanced Trading Bot Framework" 7 base_url: "/docs/" 8 9 # Main navigation structure 10 navigation: 11 getting_started: 12 title: "Getting Started" 13 description: "New to Planar? Start here" 14 icon: "🚀" 15 order: 1 16 path: "getting-started/" 17 pages: 18 - slug: "index" 19 title: "Overview" 20 description: "Getting started overview and path selection" 21 order: 1 22 - slug: "installation" 23 title: "Installation" 24 description: "Install Planar and dependencies" 25 order: 2 26 estimated_time: "10 minutes" 27 - slug: "quick-start" 28 title: "Quick Start" 29 description: "Get up and running in 15 minutes" 30 order: 3 31 estimated_time: "15 minutes" 32 - slug: "first-strategy" 33 title: "First Strategy" 34 description: "Build your first trading strategy" 35 order: 4 36 estimated_time: "20 minutes" 37 next_section: "guides" 38 39 guides: 40 title: "Development Guides" 41 description: "Build trading strategies" 42 icon: "📚" 43 order: 2 44 path: "guides/" 45 pages: 46 - slug: "index" 47 title: "Overview" 48 description: "Guide overview and topics" 49 order: 1 50 - slug: "strategy-development" 51 title: "Strategy Development" 52 description: "Core development guide" 53 order: 2 54 estimated_time: "45 minutes" 55 - slug: "data-management" 56 title: "Data Management" 57 description: "Working with market data" 58 order: 3 59 estimated_time: "30 minutes" 60 - slug: "execution-modes" 61 title: "Execution Modes" 62 description: "Sim, Paper, and Live trading" 63 order: 4 64 estimated_time: "25 minutes" 65 - slug: "optimization" 66 title: "Optimization" 67 description: "Parameter tuning and optimization" 68 order: 5 69 estimated_time: "35 minutes" 70 - slug: "visualization" 71 title: "Visualization" 72 description: "Plotting and analysis" 73 order: 6 74 estimated_time: "20 minutes" 75 next_section: "advanced" 76 77 advanced: 78 title: "Advanced Topics" 79 description: "Advanced usage and customization" 80 icon: "⚡" 81 order: 3 82 path: "advanced/" 83 pages: 84 - slug: "index" 85 title: "Overview" 86 description: "Advanced topics overview" 87 order: 1 88 - slug: "customization" 89 title: "Customization" 90 description: "Extending Planar functionality" 91 order: 2 92 estimated_time: "40 minutes" 93 - slug: "margin-trading" 94 title: "Margin Trading" 95 description: "Advanced trading features" 96 order: 3 97 estimated_time: "30 minutes" 98 - slug: "multi-exchange" 99 title: "Multi-Exchange" 100 description: "Complex multi-exchange setups" 101 order: 4 102 estimated_time: "35 minutes" 103 - slug: "performance" 104 title: "Performance" 105 description: "Optimization and scaling" 106 order: 5 107 estimated_time: "25 minutes" 108 next_section: "reference" 109 110 reference: 111 title: "API Reference" 112 description: "Complete function documentation" 113 icon: "📖" 114 order: 4 115 path: "reference/" 116 pages: 117 - slug: "index" 118 title: "Overview" 119 description: "API reference overview" 120 order: 1 121 - slug: "configuration" 122 title: "Configuration" 123 description: "All configuration options" 124 order: 2 125 - slug: "types" 126 title: "Types" 127 description: "Type system reference" 128 order: 3 129 subsections: 130 api: 131 title: "API Documentation" 132 path: "reference/api/" 133 pages: 134 - slug: "core" 135 title: "Core API" 136 description: "Essential functions" 137 - slug: "strategies" 138 title: "Strategy API" 139 description: "Strategy development functions" 140 - slug: "exchanges" 141 title: "Exchange API" 142 description: "Exchange integration" 143 - slug: "data" 144 title: "Data API" 145 description: "Data management functions" 146 examples: 147 title: "Examples Library" 148 path: "reference/examples/" 149 pages: 150 - slug: "basic" 151 title: "Basic Examples" 152 description: "Simple usage patterns" 153 - slug: "advanced" 154 title: "Advanced Examples" 155 description: "Complex implementations" 156 next_section: "troubleshooting" 157 158 troubleshooting: 159 title: "Troubleshooting" 160 description: "Problem resolution" 161 icon: "🔧" 162 order: 5 163 path: "troubleshooting/" 164 pages: 165 - slug: "index" 166 title: "Overview" 167 description: "Problem categories and quick fixes" 168 order: 1 169 - slug: "installation-issues" 170 title: "Installation Issues" 171 description: "Setup and dependency problems" 172 order: 2 173 - slug: "strategy-problems" 174 title: "Strategy Problems" 175 description: "Strategy development issues" 176 order: 3 177 - slug: "performance-issues" 178 title: "Performance Issues" 179 description: "Speed and memory problems" 180 order: 4 181 - slug: "exchange-issues" 182 title: "Exchange Issues" 183 description: "Connection and API problems" 184 order: 5 185 next_section: "resources" 186 187 resources: 188 title: "Resources" 189 description: "Additional materials" 190 icon: "📚" 191 order: 6 192 path: "resources/" 193 pages: 194 - slug: "index" 195 title: "Overview" 196 description: "Available resources" 197 order: 1 198 - slug: "glossary" 199 title: "Glossary" 200 description: "Terms and concepts" 201 order: 2 202 - slug: "migration-guides" 203 title: "Migration Guides" 204 description: "Version update guides" 205 order: 3 206 - slug: "community" 207 title: "Community" 208 description: "Support and contacts" 209 order: 4 210 211 # User journey paths for different personas 212 user_journeys: 213 new_user: 214 title: "New to Planar" 215 description: "Complete beginner path" 216 path: 217 - "getting-started/installation" 218 - "getting-started/quick-start" 219 - "getting-started/first-strategy" 220 - "guides/strategy-development" 221 estimated_total_time: "90 minutes" 222 223 strategy_developer: 224 title: "Strategy Developer" 225 description: "Focus on building strategies" 226 path: 227 - "guides/strategy-development" 228 - "guides/data-management" 229 - "guides/execution-modes" 230 - "guides/optimization" 231 - "advanced/customization" 232 estimated_total_time: "3 hours" 233 234 advanced_user: 235 title: "Advanced User" 236 description: "Customization and scaling" 237 path: 238 - "advanced/customization" 239 - "advanced/margin-trading" 240 - "advanced/multi-exchange" 241 - "advanced/performance" 242 - "reference/api/core" 243 estimated_total_time: "2.5 hours" 244 245 troubleshooter: 246 title: "Need Help" 247 description: "Problem resolution" 248 path: 249 - "troubleshooting/index" 250 - "troubleshooting/installation-issues" 251 - "troubleshooting/strategy-problems" 252 - "resources/community" 253 estimated_total_time: "30 minutes" 254 255 # Breadcrumb configuration 256 breadcrumbs: 257 separator: " > " 258 show_home: true 259 home_title: "Docs" 260 max_depth: 4 261 262 # Cross-reference configuration 263 cross_references: 264 # Automatic linking patterns 265 auto_link_patterns: 266 - pattern: "\\b(Planar|planar)\\b" 267 link: "index.md" 268 title: "Planar Documentation" 269 - pattern: "\\bstrategy development\\b" 270 link: "guides/strategy-development.md" 271 title: "Strategy Development Guide" 272 - pattern: "\\binstallation\\b" 273 link: "getting-started/installation.md" 274 title: "Installation Guide" 275 - pattern: "\\bquick start\\b" 276 link: "getting-started/quick-start.md" 277 title: "Quick Start Guide" 278 279 # Related content suggestions 280 related_content_rules: 281 - if_category: "getting-started" 282 suggest_categories: ["guides"] 283 max_suggestions: 3 284 - if_category: "guides" 285 suggest_categories: ["advanced", "reference"] 286 max_suggestions: 4 287 - if_category: "advanced" 288 suggest_categories: ["reference", "troubleshooting"] 289 max_suggestions: 3 290 - if_category: "troubleshooting" 291 suggest_categories: ["getting-started", "guides"] 292 max_suggestions: 2 293 294 # Search configuration 295 search: 296 enabled: true 297 index_fields: ["title", "description", "content", "category"] 298 boost_factors: 299 title: 3.0 300 description: 2.0 301 category: 1.5 302 content: 1.0 303 category_filters: true 304 difficulty_filters: true