Hello dear contributor!
It is very easy to contribute to our new Giveth documentation website. We use docusaurus v2, so you can also refer to their documentation, especially for advanced changes.
However - here are the simple ways to contribute:
Click on the Edit page link at the bottom of any entry.
If your content needs an image, you should place it in this folder:
For relative links you should also import the
useBaseUrl hook from @docusaurus/useBaseUrl - place it immediately after your front matter.
Then you can import the image - i.e. the image I used above to demonstrate the look of the edit link:
In order for this to work nicely, please fork and clone from our main repository on github and make a pull request after you have made your changes.
Docusaurus will automatically create new pages from any added markdown (
.md) files with the correct frontmatter (look at current pages to get an example).
So to create a new page, you should create a new markdown document, depending on the type of content.
- User guides should be created in the
- Developer documentation should be created in the
- Updates, content that does not easily fit other categories, as well as longer entries should go into the
If you want the entry to show up in the respective sidebar you will need to add the title to the existing array:
sidebars.jsfor the docs section
sidebarsGuides.jsfor the guides section