Skip to content

Commit a4e1f6c

Browse files
smian1smian1
authored
More documentation cleanup. (#3674)
2 parents 7422310 + 21f2b1e commit a4e1f6c

25 files changed

+5423
-2871
lines changed

‎docs/doc/developer/AppSetup.mdx‎

Lines changed: 288 additions & 190 deletions
Large diffs are not rendered by default.

‎docs/doc/developer/Contribution.mdx‎

Lines changed: 102 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,121 @@
11
---
2-
title: "Contribution"
3-
description: "We welcome contributions from the community! If you are interested in improving Omi, check out our (Some of the tasks have paid bounties) To contribute:"
2+
title: "Contribution Guide"
3+
description: "Contribute to Omi and earn rewards! Some tasks have paid bounties."
44
---
55

6-
* Fork the repository
7-
* Do the changes
8-
* create a Pull Request and specifiy which issue is it related to
6+
## How to Contribute
97

10-
## Docs Contribution[​](#docs-contribution "Direct link to Docs Contribution")
8+
<Steps>
9+
<Step title="Fork the Repository">
10+
Go to [github.com/BasedHardware/Omi](https://github.com/BasedHardware/Omi) and click **Fork**.
11+
</Step>
12+
<Step title="Make Your Changes">
13+
Clone your fork, create a branch, and implement your changes.
14+
</Step>
15+
<Step title="Create a Pull Request">
16+
Submit a PR and specify which issue it relates to.
17+
</Step>
18+
</Steps>
1119

12-
Docs contributions are as important as code contributions! Our docs are located at [github docs folder](https://github.com/BasedHardware/Omi/tree/main/docs) and synced real-time with docs.omi.me
13-
14-
You can modify the docs directly from Github interface by Creating a fork => [clicking this icon](https://share.cleanshot.com/dkBSffGr) => click "preview" => create pull request
20+
---
1521

16-
# Rewards
22+
## Documentation Contributions
1723

18-
You can get rewards by submitting approved PRs (significant contribution):
24+
Docs contributions are just as important as code contributions! Our docs are located in the [GitHub docs folder](https://github.com/BasedHardware/Omi/tree/main/docs) and sync in real-time with [docs.omi.me](https://docs.omi.me).
1925

20-
* 1 PR - free DEV KIT device (necklace/glasses, depending on where you contribute)
21-
* 2 PRs - $100 of transcription credits to use the app
22-
* 5 PRs - $500 of transcription credits to use the app + giving special Contributor role in Discord
23-
* 10 PRs - we will fly you out to San Francisco to hangout with Based Hardware team
26+
<Tip>
27+
You can edit docs directly from GitHub: Fork the repo → [click the edit icon](https://share.cleanshot.com/dkBSffGr) → click "Preview" → create a pull request.
28+
</Tip>
2429

25-
### What is a significant contribution and what will be merged?[​](#what-is-a-significant-contribution-and-what-will-be-merged "Direct link to What is a significant contribution and what will be merged?")
30+
---
2631

27-
* Something you spent 5h+ on. Can be multiple contributions with smaller time spent
28-
* Either a new feature or a major bug
29-
* Quality code with explanation
32+
## Contribution Rewards
33+
34+
Get rewarded for approved PRs with significant contributions:
35+
36+
<CardGroup cols={2}>
37+
<Card title="1 PR" icon="gift">
38+
Free DevKit device (necklace or glasses, depending on contribution area)
39+
</Card>
40+
<Card title="2 PRs" icon="coins">
41+
$100 of transcription credits
42+
</Card>
43+
<Card title="5 PRs" icon="star">
44+
$500 of transcription credits + special Contributor role in Discord
45+
</Card>
46+
<Card title="10 PRs" icon="plane">
47+
Trip to San Francisco to hang out with the Based Hardware team
48+
</Card>
49+
</CardGroup>
50+
51+
### What Qualifies as a Significant Contribution?
52+
53+
<AccordionGroup>
54+
<Accordion title="Time Investment" icon="clock">
55+
Something you spent 5+ hours on. Can be multiple smaller contributions that add up.
56+
</Accordion>
57+
<Accordion title="Impact" icon="bolt">
58+
Either a new feature or a major bug fix.
59+
</Accordion>
60+
<Accordion title="Quality" icon="check">
61+
Quality code with clear explanations.
62+
</Accordion>
63+
</AccordionGroup>
64+
65+
<Info>
66+
To claim your reward, email [team@basedhardware.com](mailto:team@basedhardware.com) with:
67+
- List of your contributions
68+
- Your address
69+
- Email and phone number
70+
</Info>
3071

31-
To receive the reward, please send an email to [team@basedhardware.com](mailto:team@basedhardware.com) with a list of your contributions, address, email and phone number
72+
---
3273

33-
# Paid [Bounties](https://github.com/BasedHardware/Omi/issues?q=is:open+is:issue+label:%22Paid+Bounty+%F0%9F%92%B0%22)
74+
## Paid Bounties
3475

3576
Get paid to improve AI wearables!
3677

37-
Some of the tickets are paid bounties! You can check which ones, but filtering with the ["Paid Bounty" label](https://github.com/BasedHardware/Omi/issues?q=is:open+is:issue+label:%22Paid+Bounty+%F0%9F%92%B0%22)
78+
<Card title="View Paid Bounties" icon="money-bill" href="https://github.com/BasedHardware/Omi/issues?q=is:open+is:issue+label:%22Paid+Bounty+%F0%9F%92%B0%22">
79+
Browse open issues with the "Paid Bounty" label
80+
</Card>
3881

39-
## Bounty Rules[​](#bounty-rules "Direct link to Bounty Rules")
82+
### Bounty Rules
4083

41-
* code must be merged into master branch
42-
* bounty eligibility is solely at our discretion
43-
* you can "lock" the bounty task, but only after your first pull request is merged.
44-
* send an email to [team@basedhardware.com](mailto:team@basedhardware.com) with a link to your bounty + paypal account to claim.
84+
| Rule | Description |
85+
|------|-------------|
86+
| Code must be merged | Your code must be merged into the master branch |
87+
| Eligibility | Bounty eligibility is solely at our discretion |
88+
| Locking a task | You can "lock" a bounty task, but only after your first PR is merged |
89+
| Claiming payment | Email [team@basedhardware.com](mailto:team@basedhardware.com) with bounty link + PayPal account |
4590

46-
### What if there are no paid bounties available?[​](#what-if-there-are-no-paid-bounties-available "Direct link to What if there are no paid bounties available?")
91+
### No Bounties Available?
92+
93+
If there are no paid bounties available, you can suggest your own:
94+
95+
<Steps>
96+
<Step title="Browse Open Issues">
97+
Filter by [open issues](https://github.com/BasedHardware/Omi/issues?q=is:open+is:issue) without the "bounty" label.
98+
</Step>
99+
<Step title="Suggest a Bounty">
100+
Comment on the issue and ping @josancamon19 or @kodjima33 with your bounty suggestion.
101+
</Step>
102+
</Steps>
103+
104+
---
47105

48-
If there are no paid bounties available, you can suggest your own. Simply filter by [open issues](https://github.com/BasedHardware/Omi/issues?q=is:open+is:issue+) with no "bounty" label and suggest your own bounty while pinging @ josancamon19 or @kodjima33
106+
## Get Started
107+
108+
<CardGroup cols={2}>
109+
<Card title="GitHub Issues" icon="github" href="https://github.com/BasedHardware/Omi/issues">
110+
Browse all open issues
111+
</Card>
112+
<Card title="Paid Bounties" icon="money-bill" href="https://github.com/BasedHardware/Omi/issues?q=is:open+is:issue+label:%22Paid+Bounty+%F0%9F%92%B0%22">
113+
View issues with bounties
114+
</Card>
115+
<Card title="Discord" icon="discord" href="http://discord.omi.me">
116+
Join the community
117+
</Card>
118+
<Card title="Documentation" icon="book" href="https://github.com/BasedHardware/Omi/tree/main/docs">
119+
Contribute to docs
120+
</Card>
121+
</CardGroup>

0 commit comments

Comments
 (0)