-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Hey there! 🖖 This is the go-to spot for everything you need to know about RetailDAO’s documentation. Whether you’re a contributor, a community member, or just curious about our retail-focused DAO, we’ve got you covered with clear, concise guides to help you navigate and get involved.
RetailDAO is a decentralized community working to revolutionize retail through blockchain and collective governance. Our docs (hosted on RetailDAO.github.io/Docs) explain how it all works, from governance rules to technical setups.
-
Get Started: Learn how to use our docs and explore the project.
-
Contribute: Want to add or improve content? Check out how to submit changes.
-
FAQs: Quick answers to common questions.
Jump in, explore, and let’s discuss what's on your mind!
New to RetailDAO? No worries! Our docs are built to help you understand the DAO and its tools. Here’s how to dive in:
-
Visit the Docs Site: Head to RetailDAO.github.io/Docs to browse our static site, built from Markdown files in the retail-DAO-docs folder.
-
Key Topics: Check out guides on:
- DAO governance: How we make decisions.
-
Smart contracts: The tech powering RetailDAO.
-
Community roles: How you can join or contribute.
-
Search Tips: Use the site’s sidebar for quick navigation.
Need help? Open an issue in the Docs repo or ping us in the community chat (link TBD)!
Want to improve our docs or fix a typo? We love contributions! Here’s how to jump in:
-
Open an Issue:
- Got an idea or spotted a mistake? Create an issue in the Docs repo.
-
Use the issue template to describe your suggestion or bug.
-
Submit a Pull Request:
- Create a branch (e.g., fix-typo).
-
Edit Markdown files in the retail-DAO-docs folder.
-
Open a PR to main with a clear description (e.g., “Fixes #1” to close an issue).
-
One team member will review, and our GitHub Action checks the build.
-
Keep it clear and concise.
-
Follow Markdown best practices (e.g., use headers, lists, and links).
-
Thanks for helping make our docs better!
Frequently Asked Questions
- Q: How do I access the latest docs?
- A: Visit RetailDAO.github.io/Docs for the live site, updated automatically after changes to main.
- Q: Why did my PR fail the build check?
- A: The “report-build-status” check runs npm run build. If it fails, check the Actions tab for errors (e.g., Markdown formatting issues). Fix and push again.
- Q: Can I contribute without coding?
- A: Absolutely! Edit .md files directly on GitHub or suggest changes via issues. No coding required!
- Q: How is the site deployed?
- A: Our GitHub Action builds the site and pushes it to the gh-pages branch, hosted on GitHub Pages.