Skip to content

Commit

Permalink
updating docs structure
Browse files Browse the repository at this point in the history
  • Loading branch information
divine-comedian committed Jan 12, 2024
1 parent b0a594b commit 29ae80f
Show file tree
Hide file tree
Showing 10 changed files with 47 additions and 45 deletions.
3 changes: 1 addition & 2 deletions dapps/guide0-gettingstarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@ slug: dapps/gettingStarted
---
import useBaseUrl from '@docusaurus/useBaseUrl'


Giveth.io is a platform where you can easily support projects both with cryptocurrency and fiat that you ❤️. Or create your own project and accept funding from a worldwide audience.

New to crypto? Visit our [FAQ section](./guide5-FAQ.md) where you can find more information or check out our [Donor 101 video course on youtube](https://youtube.com/playlist?list=PL4Artm1rmCWH4Q5XnrQWf8fm0xob3hbdZ&si=EnSIkaIECMiOmarE) to learn how to use the platform better.
New to crypto? Visit our [FAQ](https://giveth.io/faq) where you can find more information or check out our [Onboarding guide](https://giveth.io/onboarding) to learn how to use Giveth like a pro!

## Sign in

Expand Down
5 changes: 4 additions & 1 deletion dapps/guide1-createproject.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ Follow the prompts, and input the requested content:
:::warning
Please DO NOT enter an exchange deposit address; only use a key you control in a wallet like Metamask, or your funds may be lost.

Not all wallets are compatible with the Optimism chain; please ensure your wallet supports Optimism [here](https://www.optimism.io/apps/wallets) before conducting transactions.
:::

On the final page double check all the info you entered. If it looks good, hit `PUBLISH`, and boom, your project is live!
Expand All @@ -70,3 +69,7 @@ On the confirmation page you can choose to view your project and to share it on

## Editing my project after it's been published
If you made a mistake or need to change something on your project, it's super simple to go back and update it. If you're on the homepage, go to the top right, and click on your account, then select `My Projects`. Once you're there, you should see a page of your projects; hover over the project you wish to edit, then click the `EDIT` button. You should see your project's contents; you can scroll through and change the content you wish, and once you're done, just hit save!


## More Information
Check out our onboarding guide, complete with videos, watch how to create your project, get it [verfied](./projectVerification.md) and how to get donations!
16 changes: 5 additions & 11 deletions dapps/listedUnlisted.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,21 +41,15 @@ However, in order to remain active, the unlisted project must still exhibit:

### Examples of Projects that do not pass "Listed" criteria

1. danger dan defi: No description
![](https://i.imgur.com/ln7nrO2.png)

2. Giving your hands to help: Strange/vague description: "We want to do favours all over Canada"
![](https://i.imgur.com/TV9lNqw.jpg)

3. Pritesh
1. Giving your hands to help: Strange/vague description: "We want to do favours all over Canada"
<img alt='giving your hands to help: a project with a vague description' src={useBaseUrl('img/projectExamples/givingyourhands.png')} />

2. Pritesh
- Very minimalistic description: "We are helping poor Bangladeshi people after the crash. We are giving out rice and clothes to people around us."
- No clarity given in the details of what crash and the exact process for "giving rice and clothes"
![](https://i.imgur.com/e22OlGd.png)

4. Cats
- Very minimalistic description: "We're collecting funds to give to the local cat shelter. We always need moar funding for cats."
- No website, no clear explanation of how they will use the funds to help cats
![](https://i.imgur.com/P0fvJXE.png)
<img alt='giving your hands to help: a project with a vague description' src={useBaseUrl('img/projectExamples/pritesh.png')} />

## Cancelled Projects

Expand Down
2 changes: 1 addition & 1 deletion dapps/projectdonating.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: projectdonating
title: How do I donate to a Project?
title: Making a Donation
slug: dapps/projectdonating
---
import useBaseUrl from '@docusaurus/useBaseUrl';
Expand Down
28 changes: 15 additions & 13 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,12 @@ module.exports = {
position: 'left'
},
{
to: 'dapps/',
activeBasePath: 'dapps/',
label: 'DApps',
to: 'dapps/projectdonating',
activeBasePath: 'dapps/projectdonating',
label: 'Donors',
position: 'left'
},
{to: 'dapps/createproject', activeBasePath: 'dapps/createproject', label: 'Project Owners', position: 'left'},
{
to: 'giveconomy/',
activeBasePath: 'giveconomy',
Expand All @@ -104,7 +105,7 @@ module.exports = {
position: 'left'
},
{
to: 'blog',
href: 'https://blog.giveth.io/',
label: 'Blog',
position: 'left'
},
Expand All @@ -121,12 +122,8 @@ module.exports = {
title: 'Get Started',
items: [
{
label: 'Giveth.io',
to: 'dapps/givethIO'
},
{
label: 'Giveth TRACE',
to: 'dapps/introTrace'
label: 'Donating & Creating Projects',
to: 'dapps/gettingStarted'
},
{
label: 'GIVeconomy',
Expand All @@ -142,9 +139,14 @@ module.exports = {
href: 'https://giveth.io/join'
},
{
label: 'Twitter',
href: 'https://twitter.com/givethio'
label: 'X',
href: 'https://twitter.com/giveth'
},
{
label: 'Instagram',
href: 'https://www.instagram.com/giveth.io/'
}

]
},
{
Expand All @@ -156,7 +158,7 @@ module.exports = {
},
{
label: 'GitHub',
href: 'https://github.com/giveth/giveth-docs'
href: 'https://github.com/giveth/'
}
]
}
Expand Down
2 changes: 1 addition & 1 deletion i18n/en/docusaurus-theme-classic/footer.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"description": "The label of footer link with label=GitHub linking to https://github.com/giveth/giveth-docs"
},
"copyright": {
"message": "2022 no rights reserved - made with ❤️ by Giveth.io",
"message": "2024 no rights reserved - made with ❤️ by Giveth.io",
"description": "The footer copyright"
}
}
2 changes: 1 addition & 1 deletion i18n/tr/docusaurus-theme-classic/footer.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"description": "The label of footer link with label=GitHub linking to https://github.com/giveth/giveth-docs"
},
"copyright": {
"message": "2022 hiçbir hakkı saklı değildir - Giveth.io tarafından ❤️ hazırlanmıştır.",
"message": "2024 hiçbir hakkı saklı değildir - Giveth.io tarafından ❤️ hazırlanmıştır.",
"description": "The footer copyright"
}
}
34 changes: 19 additions & 15 deletions sidebarsDapps.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,31 @@ module.exports = {
dapps: [
{
type: 'category',
label: 'DApps Documentation',
label: 'Giveth.io Guides',
link: {
type: 'generated-index',
title: 'Dapps Documentation',
description: 'Learn more about how the Giveth Dapp works. We have a variety of articles tailored for Users and Developers for Giveth.io, Giveth TRACE and the GIVeconomy.',
title: 'Giveth.io Guides',
description: 'Learn more about how the Giveth Dapp works. We have a variety of articles tailored for Donors, Project Owners and how to use the GIV token.',
slug: 'dapps/'
},
items:[
'givethIO',
'gettingStarted',
{
type: 'category',
label: 'Donation Platform',
label: 'For Donors',
collapsed: true,
link: {type: 'doc', id: 'givethIO'},
items: ['gettingStarted','createproject','listedUnlisted','projectVerification', 'projectUpdates', 'projectdonating', 'multisigs' ,{
type: 'category',
label: 'Wallets',
items: ['torusUserGuide', 'torusonramp','importTorusMM', 'donatingmetamask'],
},
'troubleshooting','faq'],
link: {type: 'doc', id: 'projectdonating'},
items: ['projectdonating', 'donatingmetamask' ,'multisigs', 'importTorusMM',
],
},
{
type: 'category',
label: 'For Project Owners',
collapsed: true,
link: {type: 'doc', id: 'createproject'},
items: ['createproject','listedUnlisted','projectVerification', 'projectUpdates',
],
},
{ type: 'category',
label: 'GIVeconomy',
Expand All @@ -45,6 +51,8 @@ module.exports = {


,
'disclosure',
'troubleshooting',
{
type: 'category',
label: "Developer Guides",
Expand All @@ -57,10 +65,6 @@ module.exports = {
]
},
{
type: 'category',
label: "Security",
items: [ 'disclosure']
},{
type: 'category',
label: 'Giveth TRACE (Deprecated)',
link: {type: 'doc', id:'introTrace'},
Expand Down
Binary file added static/img/projectExamples/givingyourhands.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/projectExamples/pritesh.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 29ae80f

Please sign in to comment.