Welcome to the coincashew/docs repository!
This is the central hub for documentation related to CoinCashew's EthPillar and other Ethereum staking projects.
Whether you're curious about solo staking, want to run a node, or contribute your knowledge to help others—you're in the right place! 🚀
- 🛠️ Setup Guides: Instructions for staking, validator setup, and node operations.
- ⚙️ Technical References: Protocols, software, network parameters, and architecture.
- 🎓 Tutorials: Hands-on walkthroughs and troubleshooting.
- 🗄️ Operational Manuals: Maintenance and upgrade procedures.
- ❓ FAQs: Answers to common questions.
- 🤝 Contribution Guidelines: How to get involved, report issues, and suggest improvements.
- Browse folders and files for the documentation you need.
- Each guide or reference is organized by topic and clearly titled.
- Unsure where to start? Try the search bar or ask in Discord!
- Discord: Join the chat
- Reddit: r/coincashew
- X: @coincashew_
Want to help? You don't need to be a pro—docs, edits, feedback, translations, and examples all make a difference!
- Find an issue labeled good first issue
- Fork and clone the repo, create a branch, make your changes
- Open a Pull Request
This repo uses Docusaurus, a modern static website generator.
To build and preview docs locally:
-
Install dependencies (requires Node.js and npm):
npm install
-
Start the local server:
npm run start
Visit http://localhost:3000 in your browser.
-
Build the static site for production:
npm run build
-
Preview the production build (optional):
npm run serve
- Commit your changes and push your branch to your fork.
- Open a pull request with a clear summary.
- Follow our style guidelines and add friendly comments or examples.
All documentation is released under the GPL-3.0 license unless otherwise specified.
Special thanks to our contributors, community members, and open-source inspirations.
Visit docs.coincashew.com for the latest updates and resources.