Hey there, friend! You’ve landed in the RetailDAO Docs repository, the heart of our documentation for empowering retail investors through decentralized awesomeness 🤩. This is where we store all the info about our mission, governance, tokenomics, and more. Our docs are built as a snazzy static site using Docusaurus, hosted live on GitHub Pages 🌐. Whether you’re here to read, contribute, or just explore, we’re thrilled you’re with us!
This repository, Docs, is where we keep everything needed to create and maintain our documentation site. Here’s the lay of the land:
- Docs/retail-DAO-docs/docs/: This folder is where the magic happens! It contains all our Markdown (
.md) files, organized neatly by topic (like governance, tokenomics, or guides). These files are what Docusaurus turns into our beautiful website. - Root Files: In the root of the repo "/Docs", you’ll find important files like:
- CONTRIBUTING.md: Your guide to joining the fun and contributing to our docs.
- style_guide: Tips for writing and formatting docs in our friendly, consistent style.
- This very
README.mdyou’re reading now! 😄
- Docusaurus Setup: The repo includes config files (like
docusaurus.config.js) that power our static site. Don’t worry if that sounds techy—we’ll keep things simple for you!
Our site is live at retaildao.github.io/Docs/, and every change here gets deployed automatically via GitHub Pages. Cool, right?
No coding wizard? No problem! We love contributions from everyone, and you don’t need to be a tech pro to help out. Here’s what you need to know:
-
What You Can Do:
- Suggest new topics or fixes for our docs (e.g., clearer explanations or typos) in the issues panel and follow the process.
- Write or edit Markdown files, think of them as simple text files with a bit of formatting (like bold or lists).
- Share ideas to make our docs more helpful for retail investors.
-
How to Start:
- Check out our Issues panel on GitHub. This is where we discuss all proposed changes, from tiny tweaks to big ideas. Found a typo? Want a new guide? Open an issue to chat about it! 🗣️
- Read our CONTRIBUTING.md file for step-by-step help on suggesting changes or submitting updates.
- Follow our style_guide to make your writing match our friendly vibe and Markdown format.
-
Markdown 101: Markdown is super easy! It’s like writing plain text with a few tricks (e.g.,
#for headings,-for lists). Our style guide shows you how to add a metadata table and format your doc. No coding required! -
Pro Tip: Every change starts as an issue in the Issues panel. This keeps things organized and lets our community weigh in before changes go live.
Ready to jump in? Here’s the quick version:
- Open an Issue: Head to our Issues panel and create a new issue to propose your idea or report a problem. Describe what you want to change or add—this is where the conversation starts!
- Follow the Guides: Check CONTRIBUTING.md for details on submitting changes and style_guide.md for writing tips.
- Work Together: We’ll chat in the issue to refine your idea, then you can submit your changes via a pull request (don’t worry, we’ll guide you!).
Even if you’re new to GitHub, we’ve got your back. Our guides are written for beginners, and our community is here to help.
RetailDAO is all about empowering retail investors with knowledge, tools, and community. Every doc you improve or idea you share helps someone understand decentralized investing, governance, or our $RETAIL token better. You’re leveling the playing field for financial freedom—how awesome is that?
Got questions or ideas? Join the conversation in our Issues panel or connect with us in the RetailDAO community (see our Docs_repo for links). We can’t wait to see what you bring to the table!
Last updated: June 13, 2025