Skip to content

Commit

Permalink
Create ROADMAP.md (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
maryam-d authored Dec 5, 2024
1 parent c0cf860 commit 8bcca60
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Roadmap for Angor Documentation

This roadmap outlines the steps needed to build a complete and professional documentation for the Angor ecosystem. It is tailored to provide detailed guidance for **Investors**, **Founders**, and **Developers**, while also including technical guides for setting up and running **Angor App**, **Angor Hub**, **Indexer**, **Relay**, and the **Bitcoin Testnet Faucet**.

---

### 1. **Quick Start**
- [ ] What is Angor? (Introduction and overview)

### 2. **Investor**
- [ ] Getting Started (Account creation and platform introduction)
- [ ] Navigating Angor Hub (Investor-specific features)
- [ ] Investment Tips (Best practices and maximizing ROI)

### 3. **Founder**
- [ ] Getting Started (How to launch and manage projects)
- [ ] Using Angor Hub (Features for founders)
- [ ] Tips for Founders (Best practices for success)

### 4. **Developer**
- [ ] Getting Started (Overview of Angor’s codebase and setup guide)
- [ ] API Documentation (Detailed reference for Angor APIs)
- [ ] Contributing Guide (How to contribute to the Angor ecosystem)
- [ ] Developer Tools (Debugging, testing, and tools for developers)
- [ ] Setting up Angor Indexer (Installation and configuration)
- [ ] Setting up Angor Relay (Installation, configuration, and best practices)
- [ ] Setting up Bitcoin Testnet Faucet (Guide for developers)

### 5. **FAQs**
- [ ] Common Questions for Investors
- [ ] Common Questions for Founders
- [ ] Common Questions for Developers

### 6. **Support**
- [ ] Getting Help (Contacting support and troubleshooting)
- [ ] Troubleshooting Guide (Common issues and solutions)

0 comments on commit 8bcca60

Please sign in to comment.