Skip to content

Commit 342f591

Browse files
miladsoftmiladsoft
committed
Update documentation
1 parent bba4522 commit 342f591

39 files changed

+171
-22
lines changed

‎astro.config.mjs‎

Lines changed: 41 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -23,32 +23,20 @@ export default defineConfig({
2323
},
2424
sidebar: [
2525
{
26-
label: 'Overview',
27-
autogenerate: { directory: 'overview' },
26+
label: 'Quick Start',
27+
autogenerate: { directory: 'start' },
2828
},
2929
{
30-
label: 'Getting started',
31-
autogenerate: { directory: 'getting-started' },
30+
label: 'Investor',
31+
autogenerate: { directory: 'investor' },
3232
},
3333
{
34-
label: 'Creating a project',
35-
autogenerate: { directory: 'creating-a-project' },
34+
label: 'Founder',
35+
autogenerate: { directory: 'founder' },
3636
},
3737
{
38-
label: 'Investing in a project',
39-
autogenerate: { directory: 'investing-in-a-project' },
40-
},
41-
{
42-
label: 'Project updates',
43-
autogenerate: { directory: 'project-updates' },
44-
},
45-
{
46-
label: 'Fees and charges',
47-
autogenerate: { directory: 'fees-and-charges' },
48-
},
49-
{
50-
label: 'Security and control',
51-
autogenerate: { directory: 'security-and-control' },
38+
label: 'Developer',
39+
autogenerate: { directory: 'developer' },
5240
},
5341
{
5442
label: 'FAQs',
@@ -58,6 +46,39 @@ export default defineConfig({
5846
label: 'Support',
5947
autogenerate: { directory: 'support' },
6048
},
49+
50+
// {
51+
// label: 'Getting started',
52+
// autogenerate: { directory: 'getting-started' },
53+
// },
54+
// {
55+
// label: 'Creating a project',
56+
// autogenerate: { directory: 'creating-a-project' },
57+
// },
58+
// {
59+
// label: 'Investing in a project',
60+
// autogenerate: { directory: 'investing-in-a-project' },
61+
// },
62+
// {
63+
// label: 'Project updates',
64+
// autogenerate: { directory: 'project-updates' },
65+
// },
66+
// {
67+
// label: 'Fees and charges',
68+
// autogenerate: { directory: 'fees-and-charges' },
69+
// },
70+
// {
71+
// label: 'Security and control',
72+
// autogenerate: { directory: 'security-and-control' },
73+
// },
74+
// {
75+
// label: 'FAQs',
76+
// autogenerate: { directory: 'faqs' },
77+
// },
78+
// {
79+
// label: 'Support',
80+
// autogenerate: { directory: 'support' },
81+
// },
6182
],
6283
}),
6384
],

‎m.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Comprehensive Roadmap for Angor Documentation Development
2+
3+
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**.
4+
5+
---
6+
7+
### 1. **Quick Start**
8+
- [ ] What is Angor? (Introduction and overview)
9+
10+
### 2. **Investor**
11+
- [ ] Getting Started (Account creation and platform introduction)
12+
- [ ] Navigating Angor Hub (Investor-specific features)
13+
- [ ] Investment Tips (Best practices and maximizing ROI)
14+
15+
### 3. **Founder**
16+
- [ ] Getting Started (How to launch and manage projects)
17+
- [ ] Using Angor Hub (Features for founders)
18+
- [ ] Tips for Founders (Best practices for success)
19+
20+
### 4. **Developer**
21+
- [ ] Getting Started (Overview of Angor’s codebase and setup guide)
22+
- [ ] API Documentation (Detailed reference for Angor APIs)
23+
- [ ] Contributing Guide (How to contribute to the Angor ecosystem)
24+
- [ ] Developer Tools (Debugging, testing, and tools for developers)
25+
- [ ] Setting up Angor Indexer (Installation and configuration)
26+
- [ ] Setting up Angor Relay (Installation, configuration, and best practices)
27+
- [ ] Setting up Bitcoin Testnet Faucet (Guide for developers)
28+
29+
### 5. **FAQs**
30+
- [ ] Common Questions for Investors
31+
- [ ] Common Questions for Founders
32+
- [ ] Common Questions for Developers
33+
34+
### 6. **Support**
35+
- [ ] Getting Help (Contacting support and troubleshooting)
36+
- [ ] Troubleshooting Guide (Common issues and solutions)
37+
38+

‎src/components/overrides/Header.astro‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ type Link = {
1818
const links: Link[] = [
1919
{
2020
title: 'Guides',
21-
value: '/overview/introduction',
21+
value: '/start',
2222
transfer: true,
2323
}
2424
];

src/content/docs/creating-a-project/how-to-create-a-project.md renamed to src/content/docs/OLD/creating-a-project/how-to-create-a-project.md

File renamed without changes.

src/content/docs/creating-a-project/images/create-a-project.png renamed to src/content/docs/OLD/creating-a-project/images/create-a-project.png

File renamed without changes.

src/content/docs/creating-a-project/images/set-milestone.png renamed to src/content/docs/OLD/creating-a-project/images/set-milestone.png

File renamed without changes.

src/content/docs/creating-a-project/images/submit-for-review.png renamed to src/content/docs/OLD/creating-a-project/images/submit-for-review.png

File renamed without changes.

src/content/docs/faqs/common-questions.md renamed to src/content/docs/OLD/faqs/common-questions.md

File renamed without changes.

src/content/docs/faqs/images/FAQs.png renamed to src/content/docs/OLD/faqs/images/FAQs.png

File renamed without changes.

src/content/docs/fees-and-charges/images/Angor-Vs-Traditional-Crowdfunding.png renamed to src/content/docs/OLD/fees-and-charges/images/Angor-Vs-Traditional-Crowdfunding.png

File renamed without changes.

0 commit comments

Comments
 (0)