mo/nt8-sdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
cleanup/wrappers-pass2
nt8-sdk/docs/INDEX.md

5.9 KiB
Raw Permalink Blame History

⚠️ HISTORICAL — see docs/00-governance/ for current state

This file may contain outdated or mixed historical information. Canonical current-state documentation lives in docs/00-governance/. This file is retained for history/reference only. Navigation links in this file may be stale or broken.

NT8 SDK - Documentation Index

Complete documentation for the NT8 Institutional Trading SDK

📚 Documentation Structure

Getting Started

Technical Documentation

Project Documentation

📖 Reading Guide

For New Users

  1. Start with Quick Start Guide
  2. Read README overview
  3. Follow Deployment Guide

For Developers

  1. Review Architecture Overview
  2. Study API Reference
  3. Read Development Spec

For Traders

  1. Read Quick Start Guide
  2. Review risk management in README
  3. Follow Deployment Guide deployment steps

📂 Documentation by Topic

Risk Management

Position Sizing

Order Management

Strategy Development

🎯 Common Tasks

"I want to build my first strategy"

  1. Quick Start Guide
  2. README: Strategy Examples
  3. API Reference: IStrategy

"I want to configure risk limits"

  1. README: Risk Configuration
  2. API Reference: RiskConfig
  3. Architecture: Risk State

"I want to deploy to production"

  1. Deployment Guide: Production Section
  2. README: Deployment Section

"I want to optimize position sizing"

  1. README: Sizing Methods
  2. API Reference: Sizing Methods
  3. Architecture: Sizing Design

"I want to understand the architecture"

  1. Architecture: System Overview
  2. Architecture: Component Design
  3. Architecture: Data Flow

📊 Documentation Statistics

Document Pages Lines Size
README.md ~50 1,200 24KB
API_REFERENCE.md ~40 1,000 21KB
ARCHITECTURE.md ~50 1,300 26KB
DEPLOYMENT_GUIDE.md ~35 570 14KB
QUICK_START.md ~10 190 4KB
PHASE2_COMPLETION_REPORT.md ~30 650 14KB
Total ~215 4,910 103KB

🔄 Documentation Updates

Latest Updates (Feb 15, 2026)

  • ✅ Added Phase 2 completion report
  • ✅ Updated API reference for advanced risk/sizing
  • ✅ Added architecture documentation
  • ✅ Created deployment guide
  • ✅ Added quick start guide

Planned Updates

  • Add video tutorials
  • Add troubleshooting FAQ
  • Add performance tuning guide
  • Add backtesting guide

📞 Getting Help

Documentation Issues

If you find errors or have suggestions:

  1. Check for typos or outdated information
  2. Submit issue with details
  3. Suggest improvements

Technical Support

For technical questions:

  1. Check relevant documentation section
  2. Review examples in /src/NT8.Strategies/Examples/
  3. Search existing issues
  4. Create new issue with details

🎓 Learning Path

Beginner (1-2 hours)

  • Complete Quick Start Guide
  • Read README overview
  • Run SimpleORB strategy on simulation
  • Review basic examples

Intermediate (3-5 hours)

  • Study API Reference
  • Build custom strategy
  • Configure advanced risk
  • Test position sizing methods

Advanced (5-10 hours)

  • Study Architecture document
  • Implement complex strategies
  • Optimize performance
  • Deploy to production

📝 Contributing to Documentation

Style Guide

  • Use clear, concise language
  • Include code examples
  • Add tables for comparisons
  • Use headers for organization
  • Include troubleshooting tips

Documentation Standards

  • Markdown format
  • 80-character line width (when practical)
  • Code blocks with language tags
  • Links to related sections
  • Update INDEX.md with new docs

Documentation Version: 0.2.0
Last Updated: February 15, 2026
Next Review: Phase 3 Completion