giveth / giveth-docs

Documentation and Guides for Giveth.io

docs.giveth.io

Visit the Giveth Docs

This website is built using Docusaurus 2, a modern static website generator.

---

Installation

yarn

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Translations

When you are up and running and want to work on translations please see the documentation regarding i18n from docusaurus.io, use the appropriate folders for the language you are contributing too and note that it is very important to run the application specifically in your language as every translation generates its own Single page app.

yarn start --locale es (this is an example for running the spanish version locally)

Build

yarn run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true npm run deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

giveth-docs's Issues

All-Devs contributor guide

need more feedback on first draft - what's missing?

https://docs.google.com/document/d/1IlGtslk2BLafMv056dsZGVtNN8UNrqjKU2wc7x5scCk/edit?usp=sharing

@mateodaza @MoeNick @aminlatifi @MohammadPCh @mohammadranjbarz @CarlosQ96 @laurenluz

GIVeconomy testing guidelines

ready for review!

https://docs.google.com/document/d/1sMVtJm3-xG8ZdW4kCsZFEz5uZgW_zxK-jNYlJlN00XQ/edit?usp=sharing

@laurenluz @MohammadPCh @MoeNick @aminlatifi

Update/create "governance process" documentation

we are deprecating the givgarden and should reflect that in our docs.
we should also update gov process documentation to explain how to participate in giveth dgov & how it works in an up to date way.
it would be great also to explain some of the deprecated systems and why they were deprecated (re: experments & evolution in governance)

cc @divine-comedian @WhyldWanderer @Danibelle

Remove GIVgarden references in documentation

Waiting in #203

Needs review from @laurenluz to peer review copy changes.

allow for different locales/languages to show different articles and sidebar setup

I'm creating this issue to track any solutions we can implement so we can finally merge the spanish and turkish translations that have been completed. More context below:

FROM DISCORD:

The problem is that we have some docs that are only in english and were never translated to other languages, however the docs app structure will default to showing the english version if there isn't a translated file for it
there is a file that exports an object and says which documents to show on the app, I want to change which documents are in that object based on the current translation locale set
I was able to find the variable that tells us which locale is being used but I don't know how to set conditions within a modules.export or how to import the information necessary.

I know I can get the current translation local with

import i18n from '@generated/i18n';

console.log(i18n.currentLocale)

but inside a module.export it doesn't like that

assigning @mateodaza and @CarlosQ96 for research and possible solutions!

Add new wallets to Documentation

Going through the documentation I noticed that we could update the new wallets added in the last version of the Dapp released.

Private Zenhub Image

@divine-comedian could you confirm which wallets need to be added?

Confirm all these things are on the history page

Giveth has been adding value to Ethereum for 5 years, funded solely by donations.

2016-2019 The DAO Cleanup
We led the Clean up after TheDAO hack, supporting DAO token holders in our slack to claim their money back. https://medium.com/curator-multisig-phf-official-channel/dao-token-holders-come-claim-your-money-b428f186572a

2016 Minime token
We made the Minime Token, which would be used by Aragon, Status and many other projects. https://medium.com/giveth/the-minime-token-open-sourced-by-giveth-2710c0210787

2017 Parity Multisig hack
At a Giveth Retreat we worked with the White Hat Group (we are all the same people) to rescue over 200 million dollars that were sitting in vulnerable Parity Multisigs (the first parity multisig hack) https://mashable.com/article/ethereum-stolen-white-hat-group-rescued#ZPTC98wSEPOp

2018 ScalingNOW!
Ran the ScalingNOW! effort after the CryptoKitties issues: https://www.youtube.com/playlist?list=PL4Artm1rmCWGksgoRe6HF5d9eklC01IcC which culminated in a ScalingNow Summit so different scaling researchers could connect and build a stronger network. We aggregated as much scaling information as we could so everyone could learn from each other: https://medium.com/giveth/scalingnow-summit-transcript-ea5373be8523

2018-now GivethTRACE
We built the Giveth DApp, now named GivethTRACE as a fundraising platform for charities and open source projects that allows donors to trace their donations. It was one of the earliest DApps on Ethereum to implement a Scaling solution. We actually Bridged to Ethereum Several projects evolved off of this platform, including DAppNode, BrightID, and Commons Stack. https://trace.giveth.io

2018-now Camp Decentral
We run Camp Decentral: a Burning Man camp that holds a crypto conference at burning man every year. 80+ hours of talks focused on the revolutionary aspects of crypto... no number go up talk allowed

2018-now Giveth Home
We have a crypto house in Barcelona open to the blockchain4good community its a sort of hacker pad... 100s of crypto people have stayed there, and no one has ever had to pay. https://trace.giveth.io/campaign/giveth-house

2018-2020 OpenSourceBlockExplorersNOW!
We helped to unite the various efforts being made to decentralized Ethereum infrastructure. Etherscan is great, but was a closed source central point of failure... until Blockscout emerged. When that happened this effort became DecentralizedDataNOW! https://www.youtube.com/playlist?list=PL4Artm1rmCWE5qYEOTaaPRl4fD5ORXFty

2018-now Rinkeby & xDai Validator
We were one of the original 4 xDai Validators to initialize the network with no reward for many years but this public good work has paid off now, as doing good things tends to work out in crypto! We have been part of the Rinkeby Clique since early 2020. We also Validate for the public goods focused projects: IDchain and Trustlines.

2020-now Giveth.io, the New Giveth DApp
We built a simpler donation application that is intended to make it easy for non-profits to start collecting crypto donations in under 10 minutes with no prior knowledge. With Gitcoin funding open source, we are focusing squarely on charities and have big plans to help non-profits take full advantage of the web3 space. https://giveth.io

And these are just the highlights... Giveth has been a fixture of the blockchain4good community since we rose out of the ashes of TheDAO 5 years ago and are not going anywhere. Thank you for considering us.

Draft SuperFluid Documentation

Site Structure

Proposed structure for docs.giveth.io

Guides

• Getting started
• Create a project
• Cryptocurrency donations
• FAQ (page not created yet)

Docs

• Installation
  -- Instructions for Giveth2 full stack
  --- Instructions for Giveth2 frontend (not there yet)
  --- Instructions for Giveth2 impact-graph (not there yet)
  --- Instructions for Giveth2 meili-search (not there yet)
  -- Instructions for Giveth1 full stack (?)
• Contributor's Guide
• Developer Guidelines
  -- Gitflow
  -- Styling
  -- Code conventions
• Reference
  -- Style Guide
  -- Use Case scenarios

Ctrl-F 0x8f951903c9360345b4e1b536c7f5ae8f88a64e79 and delete!

We have a new Multisig address.. but no need to add it in the text... leave the ENS name as the dominant thing

We also have giv.eth, giveth.eth, give.eth, donation.eth, and revolution.eth and they all point to our new multisig address

0x4D9339dd97db55e3B9bCBE65dE39fF9c04d1C2cd

Multisig spread sheet for more info: https://docs.google.com/spreadsheets/d/1q_5VFt9C3pX-A5V0UYRSefoNPHfn3GDvEywXGvdj7cw/edit#gid=0

Update documentation photos

We have a new dapp UI and we should go through the docs and update the photos with new screenshots that are up to date with the current UI and UX of the giveth.io dapp.

Update testing guidelines for giveth.io

A new testing guidelines doc was made for the Dapp v2 UI/UX update - it's a bit messy but has some new information we should consider
https://www.notion.so/giveth/DAPP-V2-Testing-Guideline-308586e414a441f2861807e82ec714c9

We currently have this testing doc published on the documentation https://docs.giveth.io/dapps/testing-guidelines

Review the notion document and make any necessary updates to the documentation on the the giveth-docs while maintaining a clear structure for testers