|
| 1 | +{ |
| 2 | + "roadmap_name": "Ring Platform Documentation Visualization Enhancement", |
| 3 | + "version": "1.0.0", |
| 4 | + "created": "2025-10-28", |
| 5 | + "priority": "high", |
| 6 | + "emperor_mandate": "World-class documentation for Victory of Peace", |
| 7 | + |
| 8 | + "phase_1_immediate": { |
| 9 | + "timeline": "1-2 days", |
| 10 | + "priority": "P0 - Critical", |
| 11 | + "components": [ |
| 12 | + { |
| 13 | + "name": "Timeline", |
| 14 | + "library": "react-chrono", |
| 15 | + "package": "react-chrono@^2.6.1", |
| 16 | + "file": "components/docs/timeline.tsx", |
| 17 | + "use_cases": [ |
| 18 | + "Platform version history and roadmaps", |
| 19 | + "Migration guides with temporal context", |
| 20 | + "Feature development history", |
| 21 | + "Release schedules and milestones" |
| 22 | + ], |
| 23 | + "api": { |
| 24 | + "basic": "<Timeline items={[{title, date, content}]} />", |
| 25 | + "vertical": "<Timeline mode='VERTICAL' />", |
| 26 | + "horizontal": "<Timeline mode='HORIZONTAL' />", |
| 27 | + "with_cards": "<Timeline cardHeight={200} />", |
| 28 | + "themed": "Auto-detects dark mode via CSS" |
| 29 | + }, |
| 30 | + "implementation_steps": [ |
| 31 | + "npm install react-chrono", |
| 32 | + "Create components/docs/timeline.tsx wrapper", |
| 33 | + "Add Timeline, TimelineItem exports", |
| 34 | + "Add to MDX components mapping", |
| 35 | + "Add dark mode CSS overrides", |
| 36 | + "Test with roadmap example" |
| 37 | + ], |
| 38 | + "estimated_time": "2-3 hours" |
| 39 | + }, |
| 40 | + { |
| 41 | + "name": "Math", |
| 42 | + "library": "react-katex", |
| 43 | + "packages": ["react-katex@^3.0.1", "katex@^0.16.0"], |
| 44 | + "file": "components/docs/math.tsx", |
| 45 | + "use_cases": [ |
| 46 | + "Token economics formulas (APY, staking rewards)", |
| 47 | + "Fee calculation documentation", |
| 48 | + "Mathematical proofs in smart contracts", |
| 49 | + "Algorithm complexity notation" |
| 50 | + ], |
| 51 | + "api": { |
| 52 | + "inline": "<Math>{`E = mc^2`}</Math>", |
| 53 | + "display": "<Math display>{`\\int_0^\\infty e^{-x^2} dx = \\frac{\\sqrt{\\pi}}{2}`}</Math>", |
| 54 | + "block": "<MathBlock>{`multiple\\nlines`}</MathBlock>" |
| 55 | + }, |
| 56 | + "implementation_steps": [ |
| 57 | + "npm install react-katex katex", |
| 58 | + "Import katex CSS in globals.css", |
| 59 | + "Create components/docs/math.tsx", |
| 60 | + "Add dark mode CSS for katex", |
| 61 | + "Add Math component to MDX mapping", |
| 62 | + "Test with token economics example" |
| 63 | + ], |
| 64 | + "estimated_time": "2 hours" |
| 65 | + }, |
| 66 | + { |
| 67 | + "name": "CodeSandbox", |
| 68 | + "library": "@codesandbox/sandpack-react", |
| 69 | + "package": "@codesandbox/sandpack-react@^2.14.0", |
| 70 | + "file": "components/docs/code-sandbox.tsx", |
| 71 | + "use_cases": [ |
| 72 | + "Live React component examples", |
| 73 | + "API integration tutorials", |
| 74 | + "Interactive hook demonstrations", |
| 75 | + "Server action examples" |
| 76 | + ], |
| 77 | + "api": { |
| 78 | + "simple": "<CodeSandbox code={`code here`} />", |
| 79 | + "multi_file": "<CodeSandbox files={{'/App.tsx': code1, '/utils.ts': code2}} />", |
| 80 | + "with_preview": "<CodeSandbox showPreview={true} />", |
| 81 | + "themed": "Auto-matches dark mode theme" |
| 82 | + }, |
| 83 | + "implementation_steps": [ |
| 84 | + "npm install @codesandbox/sandpack-react", |
| 85 | + "Create components/docs/code-sandbox.tsx", |
| 86 | + "Configure Sandpack with Ring Platform template", |
| 87 | + "Add dark theme configuration", |
| 88 | + "Add to MDX components mapping", |
| 89 | + "Create example in API docs" |
| 90 | + ], |
| 91 | + "estimated_time": "3-4 hours" |
| 92 | + } |
| 93 | + ], |
| 94 | + "total_estimated_time": "7-9 hours", |
| 95 | + "success_criteria": [ |
| 96 | + "All three components render correctly", |
| 97 | + "Theme switching works for all components", |
| 98 | + "Zero console errors", |
| 99 | + "Mobile responsive", |
| 100 | + "Examples in documentation" |
| 101 | + ] |
| 102 | + }, |
| 103 | + |
| 104 | + "phase_2_enhanced": { |
| 105 | + "timeline": "3-5 days", |
| 106 | + "priority": "P1 - High Value", |
| 107 | + "components": [ |
| 108 | + { |
| 109 | + "name": "Tabs", |
| 110 | + "library": "@radix-ui/react-tabs", |
| 111 | + "status": "ALREADY INSTALLED", |
| 112 | + "file": "components/docs/tabs.tsx", |
| 113 | + "use_cases": [ |
| 114 | + "Multi-language code examples (TS/JS/cURL)", |
| 115 | + "Different deployment options", |
| 116 | + "Platform comparison views" |
| 117 | + ], |
| 118 | + "implementation_steps": [ |
| 119 | + "Create styled wrapper around Radix Tabs", |
| 120 | + "Add syntax highlighting integration", |
| 121 | + "Add to MDX mapping", |
| 122 | + "Create examples" |
| 123 | + ], |
| 124 | + "estimated_time": "2 hours" |
| 125 | + }, |
| 126 | + { |
| 127 | + "name": "APIExample", |
| 128 | + "library": "react-json-view + custom", |
| 129 | + "packages": ["react-json-view@^1.21.3"], |
| 130 | + "file": "components/docs/api-example.tsx", |
| 131 | + "use_cases": [ |
| 132 | + "Interactive API request/response docs", |
| 133 | + "Server action examples", |
| 134 | + "Database query demonstrations" |
| 135 | + ], |
| 136 | + "api": { |
| 137 | + "full": "<APIExample method='POST' endpoint='/api/auth' request={{}} response={{}} />", |
| 138 | + "curl": "<APIExample showCurl={true} />", |
| 139 | + "headers": "<APIExample headers={{'Authorization': 'Bearer ...'}} />" |
| 140 | + }, |
| 141 | + "estimated_time": "4 hours" |
| 142 | + }, |
| 143 | + { |
| 144 | + "name": "Annotations", |
| 145 | + "library": "react-rough-notation", |
| 146 | + "package": "react-rough-notation@^1.0.5", |
| 147 | + "file": "components/docs/annotations.tsx", |
| 148 | + "use_cases": [ |
| 149 | + "Highlight critical security notes", |
| 150 | + "Emphasize breaking changes", |
| 151 | + "Draw attention to important concepts" |
| 152 | + ], |
| 153 | + "api": { |
| 154 | + "highlight": "<Highlight color='yellow'>text</Highlight>", |
| 155 | + "underline": "<Underline color='red'>text</Underline>", |
| 156 | + "circle": "<Circle color='blue'>text</Circle>", |
| 157 | + "box": "<Box color='green'>text</Box>" |
| 158 | + }, |
| 159 | + "estimated_time": "2 hours" |
| 160 | + }, |
| 161 | + { |
| 162 | + "name": "Charts", |
| 163 | + "library": "recharts", |
| 164 | + "package": "recharts@^2.12.0", |
| 165 | + "file": "components/docs/charts.tsx", |
| 166 | + "use_cases": [ |
| 167 | + "Performance metrics visualization", |
| 168 | + "Token analytics and growth", |
| 169 | + "User statistics", |
| 170 | + "System health monitoring" |
| 171 | + ], |
| 172 | + "api": { |
| 173 | + "line": "<LineChart data={[...]} />", |
| 174 | + "bar": "<BarChart data={[...]} />", |
| 175 | + "pie": "<PieChart data={[...]} />", |
| 176 | + "area": "<AreaChart data={[...]} />" |
| 177 | + }, |
| 178 | + "estimated_time": "5 hours" |
| 179 | + }, |
| 180 | + { |
| 181 | + "name": "FileTree", |
| 182 | + "library": "custom", |
| 183 | + "file": "components/docs/file-tree.tsx", |
| 184 | + "use_cases": [ |
| 185 | + "Project structure documentation", |
| 186 | + "File organization guides", |
| 187 | + "Migration file layouts" |
| 188 | + ], |
| 189 | + "api": { |
| 190 | + "simple": "<FileTree root='app' items={[...]} />", |
| 191 | + "with_icons": "<FileTree showIcons={true} />" |
| 192 | + }, |
| 193 | + "estimated_time": "3 hours" |
| 194 | + } |
| 195 | + ], |
| 196 | + "total_estimated_time": "16 hours" |
| 197 | + }, |
| 198 | + |
| 199 | + "phase_3_advanced": { |
| 200 | + "timeline": "1-2 weeks", |
| 201 | + "priority": "P2 - Nice to Have", |
| 202 | + "components": [ |
| 203 | + { |
| 204 | + "name": "Excalidraw", |
| 205 | + "library": "@excalidraw/excalidraw", |
| 206 | + "package": "@excalidraw/excalidraw@^0.17.0", |
| 207 | + "use_cases": [ |
| 208 | + "Hand-drawn architecture diagrams", |
| 209 | + "Whiteboard-style explanations", |
| 210 | + "Collaborative diagram editing" |
| 211 | + ], |
| 212 | + "estimated_time": "6 hours" |
| 213 | + }, |
| 214 | + { |
| 215 | + "name": "ReactFlow", |
| 216 | + "library": "@xyflow/react", |
| 217 | + "package": "@xyflow/react@^12.0.0", |
| 218 | + "use_cases": [ |
| 219 | + "Interactive workflow builders", |
| 220 | + "State machine visualizations", |
| 221 | + "Node-based architecture diagrams" |
| 222 | + ], |
| 223 | + "estimated_time": "8 hours" |
| 224 | + }, |
| 225 | + { |
| 226 | + "name": "ComparisonTable", |
| 227 | + "library": "@tanstack/react-table", |
| 228 | + "status": "ALREADY INSTALLED (@tanstack/react-query)", |
| 229 | + "file": "components/docs/comparison-table.tsx", |
| 230 | + "use_cases": [ |
| 231 | + "Feature comparison matrices", |
| 232 | + "Plan pricing tables", |
| 233 | + "Technology stack comparisons" |
| 234 | + ], |
| 235 | + "estimated_time": "4 hours" |
| 236 | + } |
| 237 | + ], |
| 238 | + "total_estimated_time": "18 hours" |
| 239 | + }, |
| 240 | + |
| 241 | + "current_components": { |
| 242 | + "implemented": [ |
| 243 | + { |
| 244 | + "name": "Mermaid", |
| 245 | + "file": "components/docs/mermaid.tsx", |
| 246 | + "features": [ |
| 247 | + "Flowcharts, sequences, mindmaps, ER, Gantt, pie, gitgraph", |
| 248 | + "MutationObserver theme switching", |
| 249 | + "Dual theme support (dark/neutral)", |
| 250 | + "Error handling with source display" |
| 251 | + ] |
| 252 | + }, |
| 253 | + { |
| 254 | + "name": "MindMap", |
| 255 | + "file": "components/docs/mindmap.tsx", |
| 256 | + "features": [ |
| 257 | + "Wrapper around Mermaid", |
| 258 | + "Auto-prepends mindmap directive", |
| 259 | + "Same theme switching as Mermaid" |
| 260 | + ] |
| 261 | + }, |
| 262 | + { |
| 263 | + "name": "Callout", |
| 264 | + "file": "components/docs/callout.tsx", |
| 265 | + "features": [ |
| 266 | + "4 types: info, warning, error, success", |
| 267 | + "Icon support", |
| 268 | + "Dark mode styling" |
| 269 | + ] |
| 270 | + }, |
| 271 | + { |
| 272 | + "name": "Steps", |
| 273 | + "file": "components/docs/steps.tsx", |
| 274 | + "features": [ |
| 275 | + "Numbered step-by-step guides", |
| 276 | + "Progressive disclosure" |
| 277 | + ] |
| 278 | + }, |
| 279 | + { |
| 280 | + "name": "Card", |
| 281 | + "file": "@/components/ui/card", |
| 282 | + "features": [ |
| 283 | + "Radix UI based", |
| 284 | + "Header, title, description, content sections" |
| 285 | + ] |
| 286 | + } |
| 287 | + ] |
| 288 | + }, |
| 289 | + |
| 290 | + "dependencies_to_add": { |
| 291 | + "phase_1": { |
| 292 | + "react-chrono": "^2.6.1", |
| 293 | + "react-katex": "^3.0.1", |
| 294 | + "katex": "^0.16.0", |
| 295 | + "@codesandbox/sandpack-react": "^2.14.0" |
| 296 | + }, |
| 297 | + "phase_2": { |
| 298 | + "react-json-view": "^1.21.3", |
| 299 | + "react-rough-notation": "^1.0.5", |
| 300 | + "recharts": "^2.12.0" |
| 301 | + }, |
| 302 | + "phase_3": { |
| 303 | + "@excalidraw/excalidraw": "^0.17.0", |
| 304 | + "@xyflow/react": "^12.0.0" |
| 305 | + } |
| 306 | + }, |
| 307 | + |
| 308 | + "implementation_order": [ |
| 309 | + "1. Math (2h) - Simplest, high value for token docs", |
| 310 | + "2. Timeline (3h) - Visual roadmaps immediately useful", |
| 311 | + "3. CodeSandbox (4h) - Interactive examples are game-changer", |
| 312 | + "4. Tabs (2h) - Multi-language examples", |
| 313 | + "5. APIExample (4h) - Professional API docs", |
| 314 | + "6. Annotations (2h) - Quick win for emphasis", |
| 315 | + "7. Charts (5h) - Analytics and metrics", |
| 316 | + "8. FileTree (3h) - Project structure clarity" |
| 317 | + ], |
| 318 | + |
| 319 | + "total_effort": { |
| 320 | + "phase_1": "7-9 hours (Timeline, Math, CodeSandbox)", |
| 321 | + "phase_2": "16 hours (Tabs, APIExample, Annotations, Charts, FileTree)", |
| 322 | + "phase_3": "18 hours (Excalidraw, ReactFlow, ComparisonTable)", |
| 323 | + "grand_total": "41-43 hours for complete suite" |
| 324 | + }, |
| 325 | + |
| 326 | + "success_metrics": { |
| 327 | + "documentation_quality": "Matches Stripe/Vercel documentation standards", |
| 328 | + "developer_productivity": "50% faster onboarding with interactive examples", |
| 329 | + "user_engagement": "3x increase in documentation time-on-page", |
| 330 | + "support_reduction": "30% fewer support questions" |
| 331 | + } |
| 332 | +} |
| 333 | + |
0 commit comments