Skip to content

Commit 634eda9

Browse files
authored
Updating Angor Docs (#1)
* docs * docs * docs * docs * docs * docs * docs * docs * docs * docs * docs * docs * docs
1 parent 29cbc3b commit 634eda9

29 files changed

+260
-18
lines changed

astro.config.mjs

+30-2
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,36 @@ export default defineConfig({
1919
autogenerate: { directory: 'overview' },
2020
},
2121
{
22-
label: 'How to Invest using Angor',
23-
autogenerate: { directory: 'how-to-investsing Angor' },
22+
label: 'Getting Started',
23+
autogenerate: { directory: 'getting-started' },
24+
},
25+
{
26+
label: 'Creating A Project',
27+
autogenerate: { directory: 'creating-a-project' },
28+
},
29+
{
30+
label: 'Investing In A Project',
31+
autogenerate: { directory: 'investing-in-a-project' },
32+
},
33+
{
34+
label: 'Project Updates',
35+
autogenerate: { directory: 'project-updates' },
36+
},
37+
{
38+
label: 'Fees And Charges',
39+
autogenerate: { directory: 'fees-and-charges' },
40+
},
41+
{
42+
label: 'Security And Control',
43+
autogenerate: { directory: 'security-and-control' },
44+
},
45+
{
46+
label: 'FAQs',
47+
autogenerate: { directory: 'faqs' },
48+
},
49+
{
50+
label: 'Support',
51+
autogenerate: { directory: 'support' },
2452
},
2553
],
2654
}),
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: "How To Create A Project"
3+
description: "A guide on how to create a project"
4+
---
5+
6+
1. Sign In: Create a new wallet or recover an existing one on Angor.
7+
8+
2. Create a New Project:
9+
![image info](./images/create-a-project.png)
10+
* Enter your project details, including title, description, goals, and funding needs.
11+
12+
* Add a Banner: Upload a banner for your project to make it stand out.
13+
14+
3. Set Milestones: Define your project milestones using time-lock contracts.
15+
![image info](./images/set-milestone.png)
16+
17+
4. Submit for Review: Once your project is ready, submit it for review.
18+
![image info](./images/submit-for-review.png)
19+
20+
### Project Approval
21+
Your project will be reviewed by the Angor team. Once approved, it will be listed for investors.
Loading
Loading
Loading
+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: "Common Questions"
3+
description: "Frequently asked questions about Angor"
4+
---
5+
6+
![image info](./images/FAQs.png)
7+
8+
#### Q1: What is Angor?
9+
10+
Angor is a decentralized crowdfunding platform that merges the security of Bitcoin with the transparency of Nostr. It allows investors to maintain control over their funds through time-lock contracts and provides the ability to recover unspent funds at any point.
11+
12+
#### Q2: How do I sign up for Angor?
13+
To sign up, visit the Angor website, click on "Sign Up," fill in the required details, and verify your email address to activate your account.
14+
15+
#### Q3: What are the prerequisites for using Angor?
16+
You need a Bitcoin wallet and a basic understanding of cryptocurrency transactions to use Angor.
17+
18+
#### Q4: How are funds released in Angor?
19+
Funds are released in stages through Bitcoin’s time-lock contracts, tied to specific project milestones. Once a milestone is reached and verified, the funds for that stage are released.
20+
21+
#### Q5: Can investors recover their funds if a project fails to meet its milestones?
22+
Yes, investors can recover unspent funds at any point if the project does not meet its milestones, ensuring they maintain control over their investments.
23+
24+
#### Q6: How do I create a project on Angor?
25+
Log in to your Angor account, navigate to the "Create Project" section, fill in the project details, add a banner, set milestones, and submit your project for review.
26+
27+
#### Q7: How do I invest in a project on Angor?
28+
Browse through the projects on the "Explore Projects" section, select a project, enter the amount you wish to invest, and confirm your investment. Wait for the transaction to confirm on the blockchain.
29+
30+
#### Q8: What is the fee structure on Angor?
31+
Angor charges a minimal fee of 2-3% on the funds raised, which is significantly lower than traditional crowdfunding platforms. There are no hidden costs, making the fee structure straightforward and simple.
32+
33+
#### Q9: How do project updates work on Angor?
34+
Project updates are posted on Nostr by the project founder. Founders can import the project’s private key to a Nostr client and post updates directly. This ensures transparency and regular communication with investors.
35+
36+
#### Q10: How can I get support if I encounter issues on Angor?
37+
For support, you can reach out to our team through the "Contact Us" section on the Angor website. Additionally, you can engage with the Angor community on forums and social media for help and support.
38+
39+
#### Q11: How secure is Angor?
40+
Angor uses Bitcoin’s time-lock contracts to ensure the security of funds. The platform also integrates Nostr for transparent communication and regular updates, providing a secure and trustworthy environment for crowdfunding.
41+
42+
#### Q12: What is a time-lock contract and how does it work?
43+
A time-lock contract is a type of Bitcoin transaction that releases funds only after a certain period or condition is met. In Angor, these contracts are used to release funds in stages, tied to project milestones, ensuring that funds are used as intended and providing security to investors.

src/content/docs/faqs/images/FAQs.png

146 KB
Loading
Loading
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: "Our Fee Structure"
3+
description: "How our fee structure works"
4+
---
5+
6+
* Platform Fee: Angor charges a minimal fee of 2-3% on funds raised, significantly lower than traditional platforms.
7+
8+
* No Hidden Costs: No setup fees, transfer fees, or additional charges.
9+
10+
## Comparison with Traditional Crowdfunding Platforms
11+
![image info](./images/Angor-Vs-Traditional-Crowdfunding.png)
12+
* Platform Fee: Traditional platforms charge 5-10%.
13+
14+
* Additional Fees: Setup, transfer, and other hidden fees are common.
15+
16+
* Advantages of Angor: Lower costs and a simpler, transparent fee structure.
17+
18+
### Example Scenario
19+
20+
* Traditional Platform: A project raises $100,000. With a 5% platform fee and additional charges, the total cost might be $7,000, leaving $93,000 for the project.
21+
22+
* Angor: The same project raises $100,000. With a 2-3% fee, the total cost would be $2,000 to $3,000, leaving $97,000 to $98,000 for the project.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Creating A Wallet
3+
description: Getting started description
4+
---
5+
6+
* Step 1: Sign Up on Angor
7+
![image info](./images/wallet1.png)
8+
Sign up on the Angor platform: Visit the Angor website and complete the registration process.
9+
10+
* Step 2: Create a Wallet
11+
![image info](./images/wallet.png)
12+
Navigate to the wallet creation section: Once logged in, go to the wallet creation area on your dashboard.
13+
Click on “Create Wallet”: Simply click the “Create Wallet” button.
14+
15+
Wallet Setup: Angor will automatically generate and set up your Bitcoin wallet for you.
16+
17+
* Step 3: Backup Recovery Phrases
18+
![image info](./images/wallet2.png)
19+
Record Your Recovery Phrases: After creating your wallet, you'll receive a set of recovery phrases. Write them down and keep them in a secure place.
20+
21+
Verify Recovery Phrases: You may be asked to verify your recovery phrases to ensure they were recorded correctly.
22+
23+
Store Safely: Keep your recovery phrases safe, as they are the only way to recover your wallet if you lose access.
24+
Loading
Loading
Loading

src/content/docs/how-to-invest-using-angor/getting-started.md

-11
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: "How to Invest"
3+
description: "Guide on how to invest in Angor"
4+
---
5+
6+
1. Browse Projects: Explore projects listed on Angor.
7+
![image info](./images/browse-projects.png)
8+
2. Select a Project: Choose a project that interests you.
9+
![image info](./images/select-project.png)
10+
3. Invest Funds: Decide on an amount, confirm your investment, and wait for the transaction to confirm on the blockchain.
11+
![image info](./images/Invest-funds.png)
12+
* Click on the “Invest” button.
13+
* Enter the amount you wish to invest in the provided field.
14+
* Click “Submit” to confirm the transaction.
15+
![image info](./images/confirm-password.png)
16+
You will be asked to input your password to confirm the transaction.
17+
#### Wait for the founder to approve (this is a manual process by the founder).
18+
Wait for the transaction to be confirmed on the blockchain. This may take a few minutes.
19+
20+
### Investor Control
21+
22+
_You have the ability to recover unspent funds if a project doesn’t meet its milestones, ensuring your investment is secure._
23+
24+
Loading
Loading
Loading
Loading
+27-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,33 @@
11
---
22
title: Introduction
3-
description: Introduction description
3+
description: Introduction to Angor
44
---
55

6-
Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
7-
Writing a good guide requires thinking about what your users are trying to do.
6+
### Welcome to Angor!🚀
87

9-
## Further reading
8+
We’re revolutionizing how Bitcoin crowdfunding works by merging the security of Bitcoin with the transparency of Nostr. Our platform ensures investors maintain control over their funds through time-lock contracts, with the option to recover unspent funds at any time.
109

11-
- Read Introduction
10+
This guide will walk you through everything you need to know to get started with Angor.
11+
12+
### Key Features
13+
* Time-Lock Contracts: Funds are released in stages based on project milestones.
14+
15+
* Transparency: Regular updates and communication through Nostr.
16+
17+
* Low Fees: A minimal 2-3% platform fee with no hidden costs.
18+
19+
### How It Works
20+
21+
* Project Creation: Founders create projects with defined milestones.
22+
23+
* Investing: Investors browse projects, invest funds, and can reclaim unspent funds if milestones aren’t met.
24+
25+
##### _Fund Claiming: Founders claim funds as milestones are achieved and verified._
26+
27+
## Use Cases
28+
29+
* Crowdfunding for tech startups.
30+
31+
* Raising funds for creative projects.
32+
33+
* Supporting community-driven initiatives.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: "Posting Updates"
3+
description: "Guide on Project Updates"
4+
---
5+
6+
Founders are responsible for regularly updating investors on the project’s progress via Nostr.
7+
8+
## Founder’s Responsibility
9+
10+
* Use the project’s private key to post updates directly through a Nostr client.
11+
* Maintain transparency and regular communication with investors.
Loading
Loading
Loading
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: "Time-Lock Contracts"
3+
description: "A guide on how Time Lock Contract works"
4+
---
5+
6+
### Revolutionizing Crowdfunding with Angor
7+
![image info](./images/time-lock-contract.png)
8+
9+
* Time-lock contracts are a cornerstone of Angor’s commitment to fostering a secure and accountable environment for founders and investors. By releasing funds at predefined intervals, these contracts ensure that funded projects achieve measurable milestones before receiving additional capital. This method promotes transparency and trust throughout the funding process.
10+
11+
## How Time-Lock Contracts Enhance the Funding Experience
12+
13+
Traditional funding models often disburse the entirety of an investment upfront. This can present challenges for both founders and investors. Founders may lack the impetus to prioritize resource allocation or demonstrate efficient progress. Investors, on the other hand, might face the risk of misappropriated funds or unfulfilled promises.
14+
15+
Time-lock contracts address these concerns by creating a staged funding structure. Funds are released incrementally, contingent upon the completion of specific goals. This incentivizes founders to meticulously manage their resources and achieve tangible benchmarks. Investors benefit from the reassurance that their capital is directly tied to a project’s development, fostering a sense of trust and shared success.
16+
17+
### Benefits of Time-Lock Contracts for Founders
18+
![image info](./images/Benefits-for-founders.png)
19+
* Promotes Focus and Efficiency: Knowing that subsequent funding hinges on achieving milestones compels founders to prioritize tasks and allocate resources effectively.
20+
21+
* Improves Transparency and Builds Trust: Time-lock contracts signal a commitment to responsible use of funds, strengthening the rapport between founders and investors.
22+
23+
* Reduces Risk and Enhances Credibility: By demonstrating the ability to meet funding benchmarks, founders solidify their credibility and position themselves for future investment opportunities.
24+
25+
### Benefits of Time-Lock Contracts for Investors
26+
![image info](./images/Benefits-for-Investors.png)
27+
* Mitigates Risk of Misuse of Funds: The staged release of capital ensures that funds are channeled towards achieving project objectives.
28+
29+
* Provides Performance Visibility: Investors gain a clear view of a project’s progress, enabling them to make informed decisions about continued support.
30+
31+
* Fosters a Collaborative Environment: The shared goals outlined in the time-lock contract cultivate a sense of partnership between founders and investors.
32+
33+
## Transparency
34+
35+
Regular and transparent communication through Nostr helps keep everyone informed. Angor’s approach ensures that all stakeholders have access to up-to-date information, fostering a secure and dynamic funding ecosystem.
+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: "Getting Help"
3+
description: "Support Introduction"
4+
---
5+
6+
Contact Us: Reach out through the "Contact Us" section on the Angor website.
7+
8+
Community Support: Engage with the Angor community on forums and social media.
9+
10+
## X
11+
12+
For general updates, new feature releases and community support, keep in touch with us via X.
13+
14+
Follow us on _[X](https://x.com/blockcoredev)_.
15+
16+
## Discord
17+
18+
Join our _[Discord](https://www.blockcore.net/discord)_ community.
19+
20+
## Telegram
21+
22+
Stay connected on _[Telegram](https://t.me/angor_io)_.
23+
1.89 KB
Loading
1.55 KB
Loading

src/content/docs/support/images/X.png

717 Bytes
Loading

0 commit comments

Comments
 (0)