Skip to content

Commit fe229ba

Browse files
committed
docs: add comprehensive API documentation for all refactored modules
- Add API documentation for PineScript Debug Server modules - Add API documentation for PineScript Debugger modules - Add API documentation for Command Runners (all languages) - Add API documentation for Go Config Wizard modules - Update documentation generator to include all modules - Update README and index with new module documentation - All 6 major refactored modules now have complete API documentation
1 parent 01fe203 commit fe229ba

9 files changed

Lines changed: 1563 additions & 4 deletions

docs/README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,36 @@
1010
- [Complete API Reference](api/API-TEMPLATE-UTILS.md) - All methods and modules
1111
- [Refactored Modules API](api/REFACTORED-MODULES-API.md) - Comprehensive module documentation
1212

13+
### PineScript Debug Server
14+
- [Complete API Reference](api/API-DEBUG-SERVER.md) - Web-based debugging interface
15+
- [Security Manager](api/API-DEBUG-SERVER.md#security-manager-module) - Authentication and security
16+
- [Debug State Manager](api/API-DEBUG-SERVER.md#debug-state-manager-module) - Debug state management
17+
- [Code Analyzer](api/API-DEBUG-SERVER.md#code-analyzer-module) - Code analysis utilities
18+
- [WebSocket Manager](api/API-DEBUG-SERVER.md#websocket-manager-module) - Real-time communication
19+
20+
### PineScript Debugger
21+
- [Complete API Reference](api/API-PINE-DEBUG.md) - Command-line debugging utilities
22+
- [Argument Parser](api/API-PINE-DEBUG.md#argument-parser-module) - Command line argument parsing
23+
- [Code Analyzer](api/API-PINE-DEBUG.md#code-analyzer-module) - Code analysis and metrics
24+
- [AI Analyzer](api/API-PINE-DEBUG.md#ai-analyzer-module) - AI-assisted debugging suggestions
25+
- [Command Handler](api/API-PINE-DEBUG.md#command-handler-module) - Command execution and handling
26+
27+
### Command Runners
28+
- [Complete API Reference](api/API-COMMAND-RUNNERS.md) - Language-specific command execution
29+
- [Clojure Command Runner](api/API-COMMAND-RUNNERS.md#clojure-command-runner) - Clojure project management
30+
- [JavaScript/TypeScript Command Runner](api/API-COMMAND-RUNNERS.md#javascripttypescript-command-runner) - JS/TS project management
31+
- [Python Command Runner](api/API-COMMAND-RUNNERS.md#python-command-runner) - Python project management
32+
- [Go Command Runner](api/API-COMMAND-RUNNERS.md#go-command-runner) - Go project management
33+
- [Rust Command Runner](api/API-COMMAND-RUNNERS.md#rust-command-runner) - Rust project management
34+
- [Elixir Command Runner](api/API-COMMAND-RUNNERS.md#elixir-command-runner) - Elixir project management
35+
36+
### Go Config Wizard
37+
- [Complete API Reference](api/API-GO-CONFIG-WIZARD.md) - Go project configuration wizard
38+
- [Go Wizard Core](api/API-GO-CONFIG-WIZARD.md#go-wizard-core-module) - Core wizard functionality
39+
- [Go Project Detector](api/API-GO-CONFIG-WIZARD.md#go-project-detector-module) - Project detection
40+
- [Go Config Generator](api/API-GO-CONFIG-WIZARD.md#go-config-generator-module) - Configuration generation
41+
- [Go Project Creator](api/API-GO-CONFIG-WIZARD.md#go-project-creator-module) - Project creation utilities
42+
1343
## 🚀 Quick Start
1444

1545
### Getting Started
@@ -66,6 +96,10 @@
6696
### Module Status
6797
- **PineScript Optimizer**: ✅ Production ready
6898
- **TemplateUtils**: ✅ Production ready
99+
- **PineScript Debug Server**: ✅ Production ready
100+
- **PineScript Debugger**: ✅ Production ready
101+
- **Command Runners**: ✅ Production ready
102+
- **Go Config Wizard**: ✅ Production ready
69103
- **Validation Scripts**: ✅ All passing
70104
- **Documentation**: ✅ Complete
71105

@@ -79,5 +113,5 @@ This documentation is automatically generated. To update:
79113

80114
---
81115

82-
*Last Generated: 2026-01-28T01:10:24.099Z*
116+
*Last Generated: 2026-01-28T01:29:17.979Z*
83117
*Documentation Version: 1.0.0*

0 commit comments

Comments
 (0)