You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -105,17 +111,16 @@ The values such as `community/intro` represent the path of the markdown file you
105
111
You can read more about writing documentation pages in the [Docusaurus docs](https://v2.docusaurus.io/docs/docs).
106
112
107
113
[Guide To Markdown Features](https://v2.docusaurus.io/docs/markdown-features)
108
-
- Learn about the various syntax you can use in the docs files
109
-
- Learn how you can embed React Components *within* your markdown using [MDX](https://mdxjs.com)
110
114
115
+
- Learn about the various syntax you can use in the docs files
116
+
- Learn how you can embed React Components _within_ your markdown using [MDX](https://mdxjs.com)
111
117
112
118
#### Making a New Page
113
119
114
120
If you would like to create ad-hoc pages using React, you can do so by creating a js file in the [pages](pages) directory. This will work like any other React web-app!
115
121
116
122
You can read more about creating pages in the [Docusaurus docs](https://v2.docusaurus.io/docs/creating-pages).
117
123
118
-
119
124
#### Adding to Navigation
120
125
121
126
To add links to the top Navigation bar or Footer you can dit the [docusaurus.config.js](docusaurus.config.js) file.
@@ -124,44 +129,41 @@ To add links to the top Navigation bar or Footer you can dit the [docusaurus.con
124
129
module.exports= {
125
130
themeConfig: {
126
131
navbar: {
127
-
title:'SourceCred',
132
+
title:"SourceCred",
128
133
logo: {
129
-
alt:'SourceCred Logo',
130
-
src:'img/favicon.png',
134
+
alt:"SourceCred Logo",
135
+
src:"img/favicon.png",
131
136
},
132
137
links: [
133
-
{
134
-
to:'docs/community/intro',
135
-
activeBasePath:'docs',
136
-
label:'📖 Docs',
137
-
position:'left',
138
-
},
139
-
{
140
-
href:'https://github.com/sourcecred',
141
-
label:'Github',
142
-
position:'right',
143
-
},
138
+
{
139
+
to:"docs/community/intro",
140
+
activeBasePath:"docs",
141
+
label:"📖 Docs",
142
+
position:"left",
143
+
},
144
+
{
145
+
href:"https://github.com/sourcecred",
146
+
label:"Github",
147
+
position:"right",
148
+
},
144
149
// ... other links
145
150
],
146
151
},
147
-
}
148
-
}
152
+
},
153
+
};
149
154
```
150
155
151
156
You can read more about configuring the navigation in the [Docusaurus docs](https://v2.docusaurus.io/docs/docusaurus.config.js#themeconfig).
152
157
153
-
154
158
### 4. Open a Pull Request
155
159
156
160
Once you've made changes on your new branch, open a new pull request to have them
157
161
reviewed! When they are merged to master they will go live on the site.
158
162
159
-
160
163
#### A Note On Comments
161
164
162
165
You can add a comment to a page using the following syntax:
Copy file name to clipboardexpand all lines: docs/beta/FAQ.md
+14-13
Original file line number
Diff line number
Diff line change
@@ -2,19 +2,20 @@
2
2
title: ❓FAQ
3
3
description: Your hottest questions about SourceCred, answered.
4
4
---
5
+
5
6
### Is SourceCred gameable? How do you prevent Sybil attacks?
6
7
7
-
All systems are gameable and in the end, our goal is not to eliminate gaming but instead become resistant to it. SourceCred's transparency around contribution and reward combined with an emotionally mature community capable of social moderation, creates a system that can quickly identify attacks (intentional or unintentional) and communicate to or shut down the attacker. The retroactive nature of SourceCred's algorithm and long-term + short-term payout system means that from Sybils (one person using multiple accounts to farm Cred), to exploitation, to unintentional gaming or bugs; it's easy to see, correct weights, and respond socially with community moderation.
8
+
All systems are gameable and in the end, our goal is not to eliminate gaming but instead become resistant to it. SourceCred's transparency around contribution and reward combined with an emotionally mature community capable of social moderation, creates a system that can quickly identify attacks (intentional or unintentional) and communicate to or shut down the attacker. The retroactive nature of SourceCred's algorithm and long-term + short-term payout system means that from Sybils (one person using multiple accounts to farm Cred), to exploitation, to unintentional gaming or bugs; it's easy to see, correct weights, and respond socially with community moderation.
8
9
9
10
There are many community-oriented measures that can be implemented to mitigate the risk of an attack. To learn about how the SourceCred community itself handles it, check out this [tweet thread](https://twitter.com/boredGenius/status/1275963160852221952).
10
11
11
12
### What platforms does SourceCred currently support?
12
13
13
-
SourceCred has plugins that can gather data for Cred scores from:
14
+
SourceCred has plugins that can gather data for Cred scores from:
14
15
15
-
* Discourse
16
-
* GitHub
17
-
* Discord
16
+
- Discourse
17
+
- GitHub
18
+
- Discord
18
19
19
20
We will be working on supporting additional platforms in the future. If you are interested in contributing to the development of more plugins, check out our [Getting Involved](/docs/beta/get-involved) page.
20
21
@@ -30,17 +31,17 @@ Existing plugins can also offer workarounds for communities. For example, the So
30
31
31
32
#### Use it if:
32
33
33
-
* ✅ Your community lives on one or more of the supported platforms
34
-
* ✅ Your community has strong leadership, emotional maturity and conflict resolution skills
35
-
* ✅ The [trust level](../concepts/trust_levels.md) of your community is high and/or the stakes are low
36
-
* ✅ Your community is relatively small (i.e. not larger than [Dunbar's number](https://en.wikipedia.org/wiki/Dunbar%27s_number))
37
-
* ✅ You're a fan of decentralized economies and changing the way we think about and distribute value
34
+
- ✅ Your community lives on one or more of the supported platforms
35
+
- ✅ Your community has strong leadership, emotional maturity and conflict resolution skills
36
+
- ✅ The [trust level](../concepts/trust_levels.md) of your community is high and/or the stakes are low
37
+
- ✅ Your community is relatively small (i.e. not larger than [Dunbar's number](https://en.wikipedia.org/wiki/Dunbar%27s_number))
38
+
- ✅ You're a fan of decentralized economies and changing the way we think about and distribute value
38
39
39
40
#### Don't use it if:
40
41
41
-
* ⛔️ You are looking for a silver bullet for community engagement/participation
42
-
* ⛔️ You don't want to put time/effort into educating yourself and your community on how SourceCred works
43
-
* ⛔️ You're looking for a production-ready, ultra-robust system that won't make breaking changes
42
+
- ⛔️ You are looking for a silver bullet for community engagement/participation
43
+
- ⛔️ You don't want to put time/effort into educating yourself and your community on how SourceCred works
44
+
- ⛔️ You're looking for a production-ready, ultra-robust system that won't make breaking changes
44
45
45
46
### How is SourceCred funded and how will it be sustainable long term?
Copy file name to clipboardexpand all lines: docs/beta/best-resources-for-new-contributors.md
+17-20
Original file line number
Diff line number
Diff line change
@@ -7,45 +7,42 @@ description: The tools, guides and resources that are most relevant to people lo
7
7
8
8
First, try getting familiar with these helpful docs:
9
9
10
-
* What is SourceCred?
11
-
* How Cred Works
12
-
* How Grain Works
13
-
* FAQ
14
-
* Getting Involved
15
-
* Our Platforms
16
-
* Our Calls
17
-
*\*\*Checking Your Cred/Grain
18
-
*\*\*Roles and Trust
19
-
*\*\*Code of Conduct
10
+
- What is SourceCred?
11
+
- How Cred Works
12
+
- How Grain Works
13
+
- FAQ
14
+
- Getting Involved
15
+
- Our Platforms
16
+
- Our Calls
17
+
-\*\*Checking Your Cred/Grain
18
+
-\*\*Roles and Trust
19
+
-\*\*Code of Conduct
20
20
21
21
(\*\*doesn't exist and isn't currently in-scope for beta)
22
22
23
23
## Organizational Tools
24
24
25
25
We have a few MVP (minimum viable product) organizational tools for our internal operations. Looking through these can help you get an idea of what kinds of projects are being worked on in SourceCred.
26
26
27
-
28
27
### <ins>[Initiatives Index Spreadsheet](https://docs.google.com/spreadsheets/d/1IYNXNghAnMAGPof3f9bZZQeIGxlOHJQrUmu9qONY3KQ/edit#gid=0)</ins>
29
28
30
29
The Initiatives Index is an MVP tool for exploring the current projects/goals within SourceCred right now. Each "Branch" of the project has "Initiatives" (aka projects or goals). Looking through the list you can see whether an initiative is in action or on the wishlist, who's working on it, and how high of a priority it is for us. Poke through and see if anything catches your eye or sparks an idea. If you find yourself really gravitating towards a particular branch, consider going to their Branch Meeting.
31
30
32
-
33
31
### <ins>[Docs Index Spreadsheet](https://docs.google.com/spreadsheets/d/1IYNXNghAnMAGPof3f9bZZQeIGxlOHJQrUmu9qONY3KQ/edit#gid=0)</ins>
34
32
35
33
The Docs Index is a spreadsheet where we organize the documentation we're writing and would like to write. If you are interested in writing, reviewing, editing or written communication, get connected to the Docs Team and see if you can help out.
Here you'll find a spreadsheet with a link at the top. By clicking the link, you'll be taken to a form where you can share about yourself and what kind of contributor you are. This just helps folks get to know you and your role in the community better. Looking through the spreadsheet can give you a better idea of who someone is as well! Note that you can always change your answers later by editing the doc itself, but you should never edit someone else's answers.
41
38
42
-
43
39
## Extra Content
44
40
45
-
Throughout SourceCred's journey, some interesting content has been created! You may enjoy looking through some of these noteworthy creations:
41
+
Throughout SourceCred's journey, some interesting content has been created! You may enjoy looking through some of these noteworthy creations:
42
+
43
+
[//]: #"UNSURE WHAT THESE ARE, WHERE TO FIND THEM, OR WHAT THEIR RELEVANCE IS"
46
44
47
-
[//]: #(UNSURE WHAT THESE ARE, WHERE TO FIND THEM, OR WHAT THEIR RELEVANCE IS)
48
-
* Evan's Explainer
49
-
* Onboarding Philosophy
50
-
* Champions vs Heros
51
-
**Looking for more suggestions of Discourse posts for beginners!*
45
+
- Evan's Explainer
46
+
- Onboarding Philosophy
47
+
- Champions vs Heros
48
+
-_Looking for more suggestions of Discourse posts for beginners!_
Copy file name to clipboardexpand all lines: docs/beta/cred.md
+3-2
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,7 @@ title: 🧮 How Cred Works
3
3
description: A description of what Cred is; how it functions, flows, and effects
4
4
projects or individuals.
5
5
---
6
+
6
7
## What is Cred?
7
8
8
9
As the name suggests, Cred is an important part of SourceCred. Cred is a metric used to describe the value which every contribution and participant has added to a specific project. Each participant has a "Cred score", which reflects how valuable all the contributions they have made to a project are. How high these scores are is determined by how important or useful their contributions have been to their community. Your Cred score determines the amount of [Grain](/docs/beta/grain) (a project-specific digital token which can be crypto or fictional currency) you'll earn.
@@ -48,12 +49,12 @@ For example, say a participant wrote an extremely insightful topic on the forum.
48
49
49
50
Since Cred can be created (minted) from nothing by the reactions of community members, there must be a balance so that Cred maintains its worth. Just like water evaporates from ponds and creeks to create the rainclouds, Cred evaporates to replenish the source from which Cred is minted. For every node on the Contribution Graph, a consistent portion of its Cred evaporates away. The evaporation rate can be toggled within the weights to be high or low depending on the needs of your community.
50
51
51
-
📝 **Note:** Evaporation does *not* mean you will lose Cred for being absent or inactive. Just as Cred is always gently evaporating across the entire ecosystem, Cred is also always flowing across the ecosystem even during times of individual inaction.
52
+
📝 **Note:** Evaporation does _not_ mean you will lose Cred for being absent or inactive. Just as Cred is always gently evaporating across the entire ecosystem, Cred is also always flowing across the ecosystem even during times of individual inaction.
52
53
53
54
### Plug-ins
54
55
55
56
In SourceCred, we mainly use "Plug-ins" to "scrape" the activity data from a particular platform (e.g.: Discord, Github, etc). For SourceCred to understand the data in a particular platform, our engineers first need to create a Plug-in for that platform specifically. For now, you can see which Plug-ins are available and learn more about each via our [Plug-in Docs](/docs/beta/plugins/github). We'll be working on more Plug-ins as time goes on and the needs of our ecosystem span more platforms.
56
57
57
58
### Want More?
58
59
59
-
For even more information about how Cred works, you can read [](https://research.protocol.ai/blog/2020/sourcecred-an-introduction-to-calculating-cred-and-grain/)["SourceCred: an introduction to calculating cred and grain"](https://research.protocol.ai/blog/2020/sourcecred-an-introduction-to-calculating-cred-and-grain/) by SourceCred participant Evan Miyazono from [Protocol Labs](https://research.protocol.ai/).
60
+
For even more information about how Cred works, you can read [](https://research.protocol.ai/blog/2020/sourcecred-an-introduction-to-calculating-cred-and-grain/)["SourceCred: an introduction to calculating cred and grain"](https://research.protocol.ai/blog/2020/sourcecred-an-introduction-to-calculating-cred-and-grain/) by SourceCred participant Evan Miyazono from [Protocol Labs](https://research.protocol.ai/).
0 commit comments