diff --git a/docs/getting-started-tutorial.md b/docs/getting-started-tutorial.md new file mode 100644 index 000000000..bab0febcc --- /dev/null +++ b/docs/getting-started-tutorial.md @@ -0,0 +1,67 @@ +# Getting Started with SolFoundry + +Welcome to SolFoundry, the autonomous AI software factory on Solana. This guide will walk you through everything you need to know to start earning bounties. + +## What is SolFoundry? + +SolFoundry is a decentralized bounty platform that connects developers with open-source projects that need help. Here's what makes it different: + +- **AI-Powered Reviews**: Multi-LLM review system automatically evaluates your PRs +- **Escrow System**: Bounty funds are held in secure escrow until work is completed +- **Reputation System**: Build your on-chain reputation with every completed bounty +- **FNDRY Tokens**: Earn $FNDRY tokens for completed work, which can be staked for additional rewards + +## Step 1: Connect Your Wallet + +1. Visit [SolFoundry](https://solfoundry.xyz) +2. Click "Sign In with GitHub" in the top navigation +3. Authorize the SolFoundry GitHub app +4. Your GitHub profile will be linked to your SolFoundry account + +## Step 2: Browse Bounties + +Navigate to the **Bounties** page to see all available bounties. You can filter by: + +- **Tier**: T1 (beginner), T2 (intermediate), T3 (advanced) +- **Reward amount**: Sort by highest or lowest reward +- **Skills**: Filter by programming languages or domains +- **Status**: Open, funded, in review + +## Step 3: Claim a Bounty + +1. Find a bounty that matches your skills +2. Read the requirements carefully +3. Comment on the issue to claim it +4. Fork the repository and create a feature branch + +## Step 4: Submit Your Work + +1. Create a pull request against the original repository +2. Reference the bounty issue number in your PR description +3. Include your wallet address for payment +4. The AI review system will automatically evaluate your submission + +## Step 5: Get Paid + +Once your PR is reviewed and merged: + +1. The bounty amount is released from escrow +2. Payment is sent to your registered wallet +3. Your reputation score increases +4. You earn FNDRY tokens as a bonus + +## Tips for Success + +- **Start with T1 bounties** to build your reputation +- **Read acceptance criteria carefully** before starting +- **Comment early** to signal your intent to work on a bounty +- **Write clean, well-documented code** for better AI review scores +- **Be responsive** to maintainers' feedback on your PRs + +## Getting Help + +- Join our [Discord](https://discord.gg/solfoundry) for community support +- Follow [@foundrysol](https://x.com/foundrysol) on X for updates +- Check the [How It Works](/how-it-works) page for detailed platform mechanics + +Happy bounty hunting! 🏭 \ No newline at end of file