Skip to content

Commit 493ad51

Browse files
committedFeb 25, 2025·
Add checklist
1 parent 90bb086 commit 493ad51

File tree

2 files changed

+145
-144
lines changed

2 files changed

+145
-144
lines changed
 

‎CHECKLIST.md

+145
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
# Angor Documentation Checklist
2+
3+
This checklist tracks the documentation requirements for the Angor ecosystem. It ensures comprehensive coverage of all features and guides across the entire platform.
4+
5+
## Status Indicators
6+
✅ = Complete
7+
🟡 = In Progress
8+
⬜ = Not Started
9+
10+
## Completion Criteria
11+
Each item must meet these requirements to be marked complete:
12+
- Content is written and peer-reviewed
13+
- Examples and screenshots are included
14+
- Technical accuracy is verified
15+
- User testing is completed
16+
- Formatting follows style guide
17+
18+
## Documentation Progress
19+
20+
### 1. **Quick Start** [🟡 In Progress]
21+
⬜ Platform Overview
22+
- ⬜ What is Angor?
23+
- ⬜ Key Features
24+
- ⬜ System Architecture
25+
- ⬜ Getting Started Guide
26+
27+
⬜ Tools and Resources
28+
- ⬜ Angor App Overview
29+
- ⬜ Angor Hub Introduction
30+
- ⬜ Available Tools
31+
- ⬜ Resource Directory
32+
33+
### 2. **General** [⬜ Not Started]
34+
⬜ Wallet Management
35+
- ⬜ Wallet Creation Process
36+
- ⬜ Security Best Practices
37+
- ⬜ Backup and Recovery
38+
- ⬜ Key Management
39+
40+
⬜ Platform Basics
41+
- ⬜ Navigation Guide
42+
- ⬜ Basic Operations
43+
- ⬜ Common Functions
44+
- ⬜ Security Features
45+
46+
### 3. **Investor Guide** [⬜ Not Started]
47+
⬜ Getting Started
48+
- ⬜ Account Creation
49+
- ⬜ Platform Introduction
50+
- ⬜ Basic Setup Guide
51+
- ⬜ Investment Preparation
52+
53+
⬜ Investment Process
54+
- ⬜ Finding Projects
55+
- ⬜ Due Diligence Guide
56+
- ⬜ Investment Workflow
57+
- ⬜ Risk Management
58+
59+
⬜ Platform Usage
60+
- ⬜ Using Angor Hub
61+
- ⬜ Project Monitoring
62+
- ⬜ Communication Tools
63+
- ⬜ Portfolio Management
64+
65+
⬜ Technical Resources
66+
- ⬜ Platform Architecture
67+
- ⬜ Security Features
68+
- ⬜ Recovery Options
69+
- ⬜ Troubleshooting Guide
70+
71+
### 4. **Founder Guide** [⬜ Not Started]
72+
⬜ Getting Started
73+
- ⬜ Platform Overview
74+
- ⬜ Account Setup
75+
- ⬜ Prerequisites
76+
- ⬜ Navigation Guide
77+
78+
⬜ Project Lifecycle
79+
- ⬜ Project Creation
80+
- ⬜ Funding Goals
81+
- ⬜ Milestones
82+
- ⬜ Timeline Management
83+
84+
⬜ Financial Management
85+
- ⬜ Multi-signature Setup
86+
- ⬜ Fund Distribution
87+
- ⬜ Milestone Payments
88+
- ⬜ Fund Returns
89+
90+
⬜ Platform Integration
91+
- ⬜ Nostr Profile
92+
- ⬜ Hub Integration
93+
- ⬜ Communication
94+
- ⬜ Updates System
95+
96+
### 5. **Developer Guide** [⬜ Not Started]
97+
⬜ Development Setup
98+
- ⬜ Environment Setup
99+
- ⬜ Dependencies
100+
- ⬜ Configuration
101+
- ⬜ Tools Setup
102+
103+
⬜ Core Development
104+
- ⬜ Architecture
105+
- ⬜ Codebase
106+
- ⬜ Contributing
107+
- ⬜ Testing
108+
109+
⬜ Components
110+
- ⬜ Hub Development
111+
- ⬜ Indexer Setup
112+
- ⬜ Relay Config
113+
- ⬜ Faucet Setup
114+
115+
⬜ Advanced Topics
116+
- ⬜ API Docs
117+
- ⬜ Security
118+
- ⬜ Performance
119+
- ⬜ Scaling
120+
121+
### 6. **FAQs** [⬜ Not Started]
122+
⬜ Platform FAQs
123+
- ⬜ General
124+
- ⬜ Technical
125+
- ⬜ Security
126+
- ⬜ Common Issues
127+
128+
⬜ Role FAQs
129+
- ⬜ Investor
130+
- ⬜ Founder
131+
- ⬜ Developer
132+
- ⬜ Support
133+
134+
### 7. **Support** [⬜ Not Started]
135+
⬜ Help Resources
136+
- ⬜ Channels
137+
- ⬜ Documentation
138+
- ⬜ Community
139+
- ⬜ Contact Info
140+
141+
⬜ Troubleshooting
142+
- ⬜ Common Issues
143+
- ⬜ Solutions
144+
- ⬜ Debug Guide
145+
- ⬜ Emergency Help

‎ROADMAP.md

-144
This file was deleted.

0 commit comments

Comments
 (0)
Please sign in to comment.