Skip to content

Commit 3e4c4a5

Browse files
authored
Merge pull request #71 from openSVM/copilot/fix-70
Create comprehensive docs with separate .md files per feature in /docs directory
2 parents a16511f + c466f17 commit 3e4c4a5

16 files changed

+8211
-1
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,30 @@
66

77
A powerful command-line interface for managing Solana Virtual Machines (SVMs) across various networks. Monitor, deploy, and manage your SVM infrastructure with a single tool.
88

9+
## 📚 Documentation
10+
11+
For comprehensive documentation, please visit the [docs](docs/) directory:
12+
13+
- **[📖 Complete Documentation Index](docs/README.md)** - Start here for all documentation
14+
- **[🚀 Quick Start Guide](docs/installation.md)** - Installation and setup
15+
- **[💡 Examples & Patterns](docs/examples.md)** - Usage examples and workflows
16+
- **[⚙️ Configuration Guide](docs/configuration.md)** - Configuration management
17+
18+
### Core Features Documentation
19+
20+
- **[🖥️ SVM Management](docs/svm-management.md)** - Manage Solana Virtual Machines
21+
- **[🏗️ Node Management](docs/node-management.md)** - Deploy and monitor nodes
22+
- **[🌐 SSH Deployment](docs/ssh-deployment.md)** - Remote deployment capabilities
23+
- **[🔗 RPC Manager](docs/rpc-manager.md)** - RPC node management
24+
- **[📊 Dashboard](docs/dashboard.md)** - Interactive monitoring interfaces
25+
26+
### Advanced Features Documentation
27+
28+
- **[🔧 Self-Repair System](docs/self-repair-system.md)** - Automated maintenance
29+
- **[📋 Log Monitoring](docs/log-monitoring.md)** - Real-time log analysis
30+
- **[⚡ Validator Enhancements](docs/validator-enhancements.md)** - Performance optimization
31+
- **[📦 eBPF Deployment](docs/ebpf-deployment.md)** - Smart contract deployment
32+
933
```mermaid
1034
graph TB
1135
User((User))

docs/README.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# OSVM CLI Documentation
2+
3+
Welcome to the comprehensive documentation for OSVM CLI - the Solana Virtual Machine command-line interface.
4+
5+
## Documentation Index
6+
7+
### Core Features
8+
- [SVM Management](svm-management.md) - Manage Solana Virtual Machines
9+
- [Node Management](node-management.md) - Deploy and monitor validator/RPC nodes
10+
- [SSH Deployment](ssh-deployment.md) - Remote deployment capabilities
11+
- [RPC Manager](rpc-manager.md) - Comprehensive RPC node management
12+
13+
### Advanced Features
14+
- [Security Audit](security-audit.md) - Comprehensive security analysis and reporting
15+
- [Self-Repair System](self-repair-system.md) - Automatic error detection and repair
16+
- [Log Monitoring](log-monitoring.md) - Real-time log analysis and auto-repair
17+
- [Validator Enhancements](validator-enhancements.md) - Hardware optimization and configuration
18+
- [eBPF Deployment](ebpf-deployment.md) - Solana program deployment
19+
20+
### User Interface
21+
- [Dashboard](dashboard.md) - Interactive monitoring dashboards
22+
- [Examples](examples.md) - Usage examples and command patterns
23+
24+
### Setup & Configuration
25+
- [Installation](installation.md) - Installation guide
26+
- [Configuration](configuration.md) - Configuration management
27+
28+
## Quick Start
29+
30+
1. [Install OSVM CLI](installation.md)
31+
2. [Configure your environment](configuration.md)
32+
3. [Try basic SVM operations](svm-management.md#quick-start)
33+
4. [Deploy your first node](node-management.md#quick-start)
34+
5. [Run a security audit](security-audit.md#quick-start)
35+
36+
## Architecture Overview
37+
38+
```mermaid
39+
flowchart TD
40+
subgraph "OSVM CLI Architecture"
41+
CLI[OSVM CLI]
42+
43+
subgraph "Core Modules"
44+
SVM[SVM Manager]
45+
NODE[Node Manager]
46+
SSH[SSH Deployment]
47+
RPC[RPC Manager]
48+
end
49+
50+
subgraph "Advanced Features"
51+
AUDIT[Security Audit]
52+
REPAIR[Self-Repair System]
53+
MONITOR[Log Monitor]
54+
DASH[Dashboard]
55+
DEPLOY[eBPF Deploy]
56+
end
57+
58+
subgraph "External Systems"
59+
SOLANA[Solana Network]
60+
REMOTE[Remote Servers]
61+
LOCAL[Local Environment]
62+
GITHUB[GitHub Repos]
63+
end
64+
end
65+
66+
CLI --> SVM
67+
CLI --> NODE
68+
CLI --> SSH
69+
CLI --> RPC
70+
71+
SVM --> REPAIR
72+
NODE --> MONITOR
73+
NODE --> DASH
74+
SSH --> DEPLOY
75+
CLI --> AUDIT
76+
77+
SSH --> REMOTE
78+
NODE --> LOCAL
79+
RPC --> SOLANA
80+
AUDIT --> GITHUB
81+
AUDIT --> LOCAL
82+
83+
classDef techDebt fill:#f6f6f6,stroke:#d9534f,color:#d9534f,font-family:Consolas,monospace,font-weight:bold
84+
```
85+
86+
## Support
87+
88+
For issues, questions, or contributions, please visit the [OSVM CLI repository](https://github.com/openSVM/osvm-cli).

0 commit comments

Comments
 (0)