Skip to content

Commit 7a6f38d

Browse files
committed
Add new documentation for founders and investors, including guides on project approval, spending, and using Angor Hub
1 parent 493ad51 commit 7a6f38d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+743
-204
lines changed
File renamed without changes.

src/content/docs/faqs/developers-faq.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,30 @@ sidebar:
88
## What is Angor, and why is it relevant for developers?
99
It allows developers to raise funds from the bitcoin community without exposing the investors to unnecessary risk, this will unlock more capital for devs, especially devs building on Bitcoin and Nostr.
1010

11-
![bitcoin](./bitcoin2.svg)
11+
![bitcoin](/bitcoin-line.svg)
1212

1313
## What technologies are used in Angor?
1414
Angor leverages:
1515
- **Bitcoin scripting:** For smart contracts and fund security.
1616
- **Nostr protocols:** For metadata storage and communication.
1717
- **Open-source tools:** To ensure transparency and scalability.
1818

19-
![bitcoin](./bitcoin2.svg)
19+
![bitcoin](/bitcoin-line.svg)
2020

2121
## What is the role of Nostr in Angor?
2222
Nostr is used for:
2323
- Storing project metadata.
2424
- Enabling secure communication between founders and investors.
2525
- Supporting the decentralized nature of Angor.
2626

27-
![bitcoin](./bitcoin2.svg)
27+
![bitcoin](/bitcoin-line.svg)
2828

2929
## How can I integrate custom features into Angor?
3030
1. Identify the feature’s purpose and design a solution.
3131
2. Submit a proposal to the Angor development team.
3232
3. Implement the feature following the coding standards and guidelines.
3333

34-
![bitcoin](./bitcoin2.svg)
34+
![bitcoin](/bitcoin-line.svg)
3535

3636
## How do I run a Nostr relay for Angor?
3737
1. Set up a server with the recommended specs.

src/content/docs/faqs/founders-faq.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ sidebar:
88
## What is Angor, and how can it help me as a founder?
99
Angor is a decentralized crowdfunding protocol that offers secure funding channels for projects. It helps founders attract serious backers by guaranteeing fund security, which fosters trust among investors.
1010

11-
![bitcoin](./bitcoin2.svg)
11+
![bitcoin](/bitcoin-line.svg)
1212

1313
## How do I create a project on Angor?
1414
To create a project:
1515
1. Register the project through Angor App.
1616
2. Define milestones and funding goals.
1717
3. Use Angor Hub to update investors and engage with the community.
1818

19-
![bitcoin](./bitcoin2.svg)
19+
![bitcoin](/bitcoin-line.svg)
2020

2121
## How does Angor ensure fund security for investors?
2222
Angor implements robust security through Bitcoin smart contracts with multiple safeguards:
@@ -28,41 +28,41 @@ Angor implements robust security through Bitcoin smart contracts with multiple s
2828

2929
This comprehensive security framework creates a trustless environment that protects both investors and founders throughout the funding lifecycle.
3030

31-
![bitcoin](./bitcoin2.svg)
31+
![bitcoin](/bitcoin-line.svg)
3232

3333
## What happens if my project doesn’t reach full funding?
3434
If funding goals are not met:
3535
- You can co-sign an exit transaction to return unspent funds to investors.
3636
- Alternatively, the penalty process allows unspent Bitcoin to revert to investors securely.
3737

38-
![bitcoin](./bitcoin2.svg)
38+
![bitcoin](/bitcoin-line.svg)
3939

4040
## What are the key advantages of using Angor as a founder?
4141
- **Increased trust:** Secure funding attracts serious investors.
4242
- **Transparency:** Updates through Nostr keep investors informed.
4343
- **Decentralization:** No intermediaries or backend systems to compromise your project.
4444

45-
![bitcoin](./bitcoin2.svg)
45+
![bitcoin](/bitcoin-line.svg)
4646

4747
## How do I communicate with my investors?
4848
Angor uses **Nostr** for direct communication. You can share updates, milestones, and progress reports in real-time via Nostr relays.
4949

50-
![bitcoin](./bitcoin2.svg)
50+
![bitcoin](/bitcoin-line.svg)
5151

5252
## What currency will I receive from investors?
5353
All funding on Angor is conducted using Bitcoin.
5454

55-
![bitcoin](./bitcoin2.svg)
55+
![bitcoin](/bitcoin-line.svg)
5656

5757
## Can I use Angor for any type of project?
5858
Yes, Angor is suitable for a variety of crowdfunding projects. However, projects that benefit from transparency and milestone-based funding are ideal.
5959

60-
![bitcoin](./bitcoin2.svg)
60+
![bitcoin](/bitcoin-line.svg)
6161

6262
## Do I need permission to use Angor?
6363
No. Angor is permissionless and censorship-resistant. You can launch and manage your project without requiring approvals from any central authority.
6464

65-
![bitcoin](./bitcoin2.svg)
65+
![bitcoin](/bitcoin-line.svg)
6666

6767
## What happens if an investor exits my project?
6868
If an investor exits, their Bitcoin becomes locked for a predefined penalty period. This ensures that funds allocated for milestones remain secure until the next step.

src/content/docs/faqs/index.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -8,47 +8,47 @@ sidebar:
88
## What is Angor?
99
Angor is a fully decentralized crowdfunding protocol using Bitcoin and Nostr protocols to ensure security and transparency.
1010

11-
![bitcoin](./bitcoin2.svg)
11+
![bitcoin](/bitcoin-line.svg)
1212

1313
## How does Angor work?
1414
Angor employs Bitcoin scripting for milestone-based funding using timelocks and multisig setups. Each milestone is represented as a UTXO, allowing secure and time-restricted fund releases.
1515

16-
![bitcoin](./bitcoin2.svg)
16+
![bitcoin](/bitcoin-line.svg)
1717

1818
## What role does Nostr play in Angor?
1919
Nostr is used for project metadata storage and enabling direct communication between founders and investors.
2020

21-
![bitcoin](./bitcoin2.svg)
21+
![bitcoin](/bitcoin-line.svg)
2222

2323
## What assets can I use on Angor?
2424
Angor exclusively supports Bitcoin for all transactions.
2525

26-
![bitcoin](./bitcoin2.svg)
26+
![bitcoin](/bitcoin-line.svg)
2727

2828
## Is Angor permissionless?
2929
Yes. Angor is fully permissionless and censorship-resistant, allowing anyone to use the platform without restrictions.
3030

31-
![bitcoin](./bitcoin2.svg)
31+
![bitcoin](/bitcoin-line.svg)
3232

3333
## How are funds secured on Angor?
3434
Angor uses Bitcoin smart contracts (time-locks and 2-of-2 multisig) to ensure the security of funds at every stage.
3535

36-
![bitcoin](./bitcoin2.svg)
36+
![bitcoin](/bitcoin-line.svg)
3737

3838
## How do I recover unspent funds?
3939
Unspent funds can be recovered through the Angor wallet by initiating a secure recovery transaction.
4040

41-
![bitcoin](./bitcoin2.svg)
41+
![bitcoin](/bitcoin-line.svg)
4242

4343
## What happens if a project isn’t fully funded?
4444
Funds can be returned to investors through the multisig setup, or a penalty process can be initiated.
4545

46-
![bitcoin](./bitcoin2.svg)
46+
![bitcoin](/bitcoin-line.svg)
4747

4848
## How can I track project updates?
4949
Project updates are shared via Nostr relays and can be accessed on Angor Hub.
5050

51-
![bitcoin](./bitcoin2.svg)
51+
![bitcoin](/bitcoin-line.svg)
5252

5353
## Does Angor charge fees?
5454
Angor charges no platform fees. Only miner fees are applicable for transactions.

src/content/docs/faqs/investors-faq.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -8,55 +8,55 @@ sidebar:
88
## What is Angor and how does it benefit me as an investor?
99
Angor is a decentralized crowdfunding protocol leveraging Bitcoin and Nostr to ensure secure and transparent investments. Investors retain control over their funds, which are safeguarded through time-lock contracts and multisig setups, significantly reducing financial risks.
1010

11-
![bitcoin](./bitcoin2.svg)
11+
![bitcoin](/bitcoin-line.svg)
1212

1313
## How does Angor protect my investment?
1414
Angor utilizes Bitcoin’s scripting language for:
1515
- **Timelocks:** Ensuring funds are released based on agreed milestones.
1616
- **Multisig:** A 2-of-2 setup that lets you exit a project securely if necessary.
1717
This combination guarantees that your funds remain secure and accessible throughout the investment process.
1818

19-
![bitcoin](./bitcoin2.svg)
19+
![bitcoin](/bitcoin-line.svg)
2020

2121
## What happens if the project doesn’t meet its funding goal?
2222
If a project isn’t fully funded:
2323
- The founder can co-sign an exit transaction using the 2-of-2 multisig to return funds.
2424
- If consent isn’t given, a predefined penalty process ensures your unspent Bitcoin is recoverable.
2525

26-
![bitcoin](./bitcoin2.svg)
26+
![bitcoin](/bitcoin-line.svg)
2727

2828
## How do I track the progress of projects I’ve invested in?
2929
You can monitor projects through the **Angor Hub**, where founders share updates and milestones. Enable notifications to receive real-time alerts for key developments.
3030

31-
![bitcoin](./bitcoin2.svg)
31+
![bitcoin](/bitcoin-line.svg)
3232

3333
## Can I recover unspent funds if I decide to exit?
3434
Yes. You can recover unspent funds through your Angor wallet. The process is:
3535
1. Initiate recovery.
3636
2. Pay the miner fee.
3737
3. Your Bitcoin will be returned securely.
3838

39-
![bitcoin](./bitcoin2.svg)
39+
![bitcoin](/bitcoin-line.svg)
4040

4141
## Are there any charges for recovering funds?
4242
Apart from miner fees, there are no additional charges. Angor ensures a cost-effective process for investors.
4343

44-
![bitcoin](./bitcoin2.svg)
44+
![bitcoin](/bitcoin-line.svg)
4545

4646
## Can I remain anonymous as an investor?
4747
Yes. Angor is privacy-focused and does not require KYC. You can invest and operate on the platform without revealing personal information.
4848

49-
![bitcoin](./bitcoin2.svg)
49+
![bitcoin](/bitcoin-line.svg)
5050

5151
## What currency can I use to invest in projects?
5252
Angor exclusively supports Bitcoin for all transactions and investments.
5353

54-
![bitcoin](./bitcoin2.svg)
54+
![bitcoin](/bitcoin-line.svg)
5555

5656
## How long does it take to recover unspent funds?
5757
The recovery process is quick and depends on the transaction fee rate you set for the recovery transaction. Higher fees ensure faster processing.
5858

59-
![bitcoin](./bitcoin2.svg)
59+
![bitcoin](/bitcoin-line.svg)
6060

6161
## Are my funds at risk if the founder doesn’t deliver the project?
6262
Angor’s unique time-lock and multisig mechanisms protect your funds. If milestones aren’t met, you can reclaim your unspent Bitcoin without relying on third-party approvals.

src/content/docs/founder/approve.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "approve"
3+
description: "approve"
4+
sidebar:
5+
order: 1
6+
---

src/content/docs/founder/benefits-of-using-angor.md

-6
This file was deleted.

src/content/docs/founder/how-angor-works .md

-6
This file was deleted.
+119
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
---
2+
title: "How Angor Works for Founders"
3+
description: "A comprehensive guide to raising funds through Angor"
4+
sidebar:
5+
order: 7
6+
---
7+
8+
# How Angor Works for Founders
9+
10+
## Your Funding Journey
11+
12+
As a founder on Angor, you can raise funds for your project in a secure and transparent way using Bitcoin. Here's how the platform works for project founders.
13+
14+
## Project Launch Process
15+
16+
### 1. Project Setup
17+
- Create your project profile
18+
- Define clear milestones
19+
- Set funding goals
20+
- Establish timeline
21+
- Upload project documentation
22+
23+
### 2. Funding Structure
24+
- Choose funding stages
25+
- Set milestone requirements
26+
- Define fund release conditions
27+
- Plan timeline for each stage
28+
- Structure investment terms
29+
30+
### 3. Managing Investments
31+
- Track incoming investments
32+
- Monitor funding progress
33+
- View investor profiles
34+
- Communicate with investors
35+
- Access funding statistics
36+
37+
## Fund Management
38+
39+
### Milestone-Based Releases
40+
- Clear completion criteria
41+
- Transparent verification process
42+
- Automatic fund releases
43+
- Progress tracking
44+
- Community validation
45+
46+
### Fund Access
47+
- Secure multi-signature system
48+
- Milestone-based releases
49+
- Simple withdrawal process
50+
- Transparent transactions
51+
- Real-time balance tracking
52+
53+
## Project Management
54+
55+
### Communication Tools
56+
- Direct investor updates
57+
- Progress reporting
58+
- Milestone announcements
59+
- Community engagement
60+
- Regular notifications
61+
62+
### Progress Tracking
63+
- Milestone completion status
64+
- Funding level indicators
65+
- Investor engagement metrics
66+
- Project timeline updates
67+
- Performance analytics
68+
69+
## Practical Timeline
70+
71+
### Project Lifecycle
72+
1. **Setup Phase**
73+
- Project creation
74+
- Documentation upload
75+
- Milestone definition
76+
- Terms establishment
77+
78+
2. **Funding Phase**
79+
- Investment collection
80+
- Investor communication
81+
- Progress tracking
82+
- Community building
83+
84+
3. **Execution Phase**
85+
- Milestone completion
86+
- Fund releases
87+
- Regular updates
88+
- Investor engagement
89+
90+
## Your Control Center
91+
92+
### What You Manage
93+
- Project details
94+
- Milestone definitions
95+
- Fund releases
96+
- Investor communications
97+
- Progress updates
98+
99+
### Built-in Tools
100+
- Project dashboard
101+
- Financial analytics
102+
- Communication platform
103+
- Document management
104+
- Progress tracking
105+
106+
## Getting Started
107+
108+
### Quick Setup Steps
109+
1. [Create Your Project](../project-creation)
110+
2. [Define Milestones](../project-lifecycle)
111+
3. [Launch Your Campaign](../project-management)
112+
113+
### Available Support
114+
- [Founder FAQ](../../faqs/founder-faq)
115+
- [Technical Support](../../support/getting-help)
116+
- Community Network
117+
- Expert Guidance
118+
119+
Remember: Angor provides the tools and infrastructure you need to raise funds securely while maintaining full control over your project's development and milestone achievements.
226 KB
Loading
111 KB
Loading
42.5 KB
Loading
131 KB
Loading
37.6 KB
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
79.3 KB
Loading
79.6 KB
Loading
101 KB
Loading
222 KB
Loading
66.4 KB
Loading
65.6 KB
Loading
65.7 KB
Loading
83.5 KB
Loading
128 KB
Loading
57.8 KB
Loading
173 KB
Loading
54.9 KB
Loading

0 commit comments

Comments
 (0)