refactor: streamline documentation and improve CLI-first workflow (#49)

Update CONTRIBUTING.md to simplify setup instructions and adopt a CLI-first approach. Refactor documentation and messaging across templates, recipes, and codebase for consistency and clarity.

Author: brunopgalvao

CONTRIBUTING.md

@@ -46,11 +46,6 @@ cargo build --release --bin dot
 ### 2. Setup Your Environment
 
 ```bash
-# Fork the repository on GitHub first, then:
-git clone https://github.com/YOUR_USERNAME/polkadot-cookbook.git
-cd polkadot-cookbook
-git remote add upstream https://github.com/polkadot-developers/polkadot-cookbook.git
-
 # Verify your setup
 dot setup
 ```

README.md

@@ -44,11 +44,11 @@ Build custom FRAME pallets and runtime logic with Rust.
 
 ### <img src=".media/icons/contracts-dark.svg#gh-dark-mode-only" width="20" height="20" alt="" /> <img src=".media/icons/contracts-light.svg#gh-light-mode-only" width="20" height="20" alt="" /> Smart Contracts (Solidity)
 
-Deploy and interact with Solidity contracts using pallet-revive.
+Deploy and interact with Solidity contracts.
 
 | Recipe | Description | Difficulty |
 |----------|-------------|------------|
-| [**Simple Counter**](recipes/simple-counter) | A simple counter smart contract using pallet-revive | <img src=".media/icons/beginner-dark.svg#gh-dark-mode-only" width="14" height="14" alt="" /> <img src=".media/icons/beginner-light.svg#gh-light-mode-only" width="14" height="14" alt="" /> Beginner |
+| [**Simple Counter**](recipes/simple-counter) | A simple counter smart contract in Solidity | <img src=".media/icons/beginner-dark.svg#gh-dark-mode-only" width="14" height="14" alt="" /> <img src=".media/icons/beginner-light.svg#gh-light-mode-only" width="14" height="14" alt="" /> Beginner |
 
 ### <img src=".media/icons/interactions-dark.svg#gh-dark-mode-only" width="20" height="20" alt="" /> <img src=".media/icons/interactions-light.svg#gh-light-mode-only" width="20" height="20" alt="" /> Basic Interactions
 
@@ -148,7 +148,7 @@ dot recipe submit my-pallet
 
 The CLI supports five recipe pathways:
 - **Runtime Development** - Build custom FRAME pallets with Rust
-- **Smart Contracts** - Deploy Solidity contracts with pallet-revive
+- **Smart Contracts** - Deploy Solidity contracts
 - **Basic Interactions** - Single-chain transactions with PAPI (TypeScript)
 - **XCM** - Cross-chain messaging with Chopsticks (TypeScript)
 - **Testing Infrastructure** - Zombienet and Chopsticks configurations

cli/src/main.rs

@@ -264,7 +264,7 @@ async fn handle_create(
         .item(
             RecipePathway::Contracts,
             "Smart Contracts (Solidity)",
-            "Deploy contracts using pallet-revive",
+            "Deploy Solidity contracts",
         )
         .item(
             RecipePathway::BasicInteraction,

core/src/config/recipe.rs

@@ -9,7 +9,7 @@ pub enum RecipeType {
     /// Polkadot SDK recipe (Runtime pallets with Rust)
     #[serde(rename = "polkadot-sdk")]
     PolkadotSdk,
-    /// Solidity smart contracts (pallet-revive)
+    /// Solidity smart contracts
     Solidity,
     /// XCM cross-chain interactions (Chopsticks)
     Xcm,

core/src/scaffold/mod.rs

@@ -167,7 +167,7 @@ impl Scaffold {
                 vec![project_path.to_path_buf()]
             }
             RecipeType::Solidity => {
-                // For Solidity recipes with pallet-revive
+                // For Solidity recipes
                 vec![
                     project_path.to_path_buf(),
                     project_path.join("tests"),
@@ -265,7 +265,7 @@ impl Scaffold {
         Ok(())
     }
 
-    /// Create files for Solidity recipes (TypeScript with pallet-revive)
+    /// Create files for Solidity recipes (TypeScript)
     async fn create_solidity_files(
         &self,
         project_path: &Path,

recipes/simple-counter/README.md

@@ -1,12 +1,10 @@
 # Simple Counter
 
-A simple counter smart contract using pallet-revive
+A simple counter smart contract in Solidity
 
 ## Overview
 
 This recipe demonstrates Solidity smart contract development using:
-- **pallet-revive** - EVM-compatible smart contracts on Polkadot
-- **Hardhat** - Development environment for Solidity
 - **Ethers.js** - Library for interacting with contracts
 
 ## Prerequisites
@@ -61,7 +59,7 @@ The recipe includes:
 
 ## What You'll Learn
 
-- How to write Solidity contracts for pallet-revive
+- How to write Solidity contracts
 - How to compile and deploy contracts
 - How to write tests for your contracts
 - How to interact with deployed contracts
@@ -75,7 +73,6 @@ The recipe includes:
 
 ## Resources
 
-- [pallet-revive Documentation](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/index.html)
 - [Solidity Documentation](https://docs.soliditylang.org/)
-- [Hardhat Documentation](https://hardhat.org/docs)
+- [Polkadot SDK Documentation](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/index.html)
 - [Ethers.js Documentation](https://docs.ethers.org/)

recipes/simple-counter/contracts/Counter.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.24;
 
 /**
  * @title Counter
- * @dev Simple counter contract demonstrating pallet-revive Solidity support
+ * @dev Simple counter contract
  */
 contract Counter {
     uint256 private count;

recipes/simple-counter/package.json

@@ -1,7 +1,7 @@
 {
   "name": "simple-counter",
   "version": "1.0.0",
-  "description": "A simple counter smart contract using pallet-revive",
+  "description": "A simple counter smart contract in Solidity",
   "scripts": {
     "compile": "hardhat compile",
     "test": "hardhat test",
@@ -13,7 +13,6 @@
   "keywords": [
     "polkadot",
     "solidity",
-    "pallet-revive",
     "smart-contracts"
   ],
   "license": "MIT OR Apache-2.0",

templates/recipe-templates/solidity-template/README.guide.md.template

@@ -4,12 +4,11 @@
 
 ## Overview
 
-A focused guide for implementing Solidity smart contracts on Polkadot using pallet-revive. This guide shows you how to quickly set up, develop, test, and deploy EVM-compatible contracts.
+A focused guide for implementing Solidity smart contracts. This guide shows you how to quickly set up, develop, test, and deploy EVM-compatible contracts.
 
 **Prerequisites:**
 - Node.js 20+
 - Solidity knowledge
-- Hardhat experience
 
 ## Quick Start
 
@@ -92,27 +91,12 @@ npm test
 ### Local Node
 
 ```bash
-# Terminal 1: Start node
-npx hardhat node
-
-# Terminal 2: Deploy
 npm run deploy:local
 ```
 
 ### Testnet
 
-Configure network in `hardhat.config.ts`:
-
-```typescript
-networks: {
-  testnet: {
-    url: "https://rpc.testnet.example",
-    accounts: [process.env.PRIVATE_KEY]
-  }
-}
-```
-
-Deploy:
+Deploy to testnet:
 ```bash
 npm run deploy:testnet
 ```
@@ -318,33 +302,12 @@ function batchUpdate(uint256[] calldata values) external {
 **Transaction reverts:**
 - Check require/revert messages
 - Verify function parameters
-- Test with hardhat console
-
-## Integration with Polkadot
-
-### Using pallet-revive
-
-pallet-revive provides EVM compatibility on Polkadot:
-
-- Deploy Solidity contracts as on Ethereum
-- Use standard tools (Hardhat, Ethers.js)
-- Interact via JSON-RPC
-- Access Polkadot-specific features (optional)
-
-### Cross-Chain Features
-
-```solidity
-// Example: Interact with Polkadot runtime
-interface IPolkadot {
-    function callPallet(bytes calldata data) external;
-}
-```
+- Review transaction logs
 
 ## Resources
 
-- [pallet-revive Docs](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/index.html)
+- [Polkadot SDK Documentation](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/index.html)
 - [Solidity Docs](https://docs.soliditylang.org/)
-- [Hardhat Docs](https://hardhat.org/docs)
 - [Ethers.js Docs](https://docs.ethers.org/)
 - [OpenZeppelin Contracts](https://docs.openzeppelin.com/contracts/)
 

templates/recipe-templates/solidity-template/README.tutorial.md.template

@@ -4,7 +4,7 @@
 
 ## Overview
 
-This tutorial teaches you Solidity smart contract development on Polkadot using **pallet-revive** - an EVM-compatible smart contract execution environment. You'll learn to write, test, deploy, and interact with Solidity contracts in the Polkadot ecosystem.
+This tutorial teaches you Solidity smart contract development. You'll learn to write, test, deploy, and interact with Solidity contracts.
 
 ## Prerequisites
 
@@ -19,10 +19,10 @@ Before starting, ensure you have:
 
 By completing this tutorial, you will understand:
 
-- How to set up a Solidity development environment for Polkadot
-- How to write EVM-compatible contracts for pallet-revive
+- How to set up a Solidity development environment
+- How to write EVM-compatible contracts
 - How to compile contracts and generate TypeScript types
-- How to write comprehensive tests using Hardhat
+- How to write comprehensive tests for your contracts
 - How to deploy contracts to local and remote networks
 - How to interact with deployed contracts using Ethers.js
 
@@ -38,10 +38,9 @@ npm install
 ```
 
 **What's installed:**
-- **Hardhat** - Development environment and test runner
 - **Ethers.js** - Library for blockchain interactions
 - **TypeScript** - Type-safe contract interactions
-- **Testing libraries** - Chai assertions and Hardhat plugins
+- **Testing libraries** - Chai assertions and testing utilities
 
 ### Step 2: Understanding the Contract Structure
 
@@ -54,7 +53,6 @@ scripts/            # Deployment scripts
 ├── deploy.ts       # Automated deployment
 test/               # Contract tests
 ├── Contract.test.ts # Test suite
-hardhat.config.ts   # Hardhat configuration
 ```
 
 ### Step 3: Writing Your Contract
@@ -101,7 +99,7 @@ npm run compile
 
 ### Step 5: Writing Tests
 
-Tests use Hardhat's testing framework:
+Write tests for your contracts:
 
 ```typescript
 import { expect } from "chai";
@@ -144,10 +142,6 @@ npm test
 Deploy to a local development node:
 
 ```bash
-# Start local node (in another terminal)
-npx hardhat node
-
-# Deploy
 npm run deploy:local
 ```
 
@@ -222,19 +216,14 @@ it("should emit ValueUpdated event", async () => {
 ### Local Development
 
 ```bash
-# Terminal 1: Start node
-npx hardhat node
-
-# Terminal 2: Deploy
 npm run deploy:local
 ```
 
 ### Testnet Deployment
 
-1. Configure network in `hardhat.config.ts`
-2. Fund your account with test tokens
-3. Deploy: `npm run deploy:testnet`
-4. Verify deployment on block explorer
+1. Fund your account with test tokens
+2. Deploy: `npm run deploy:testnet`
+3. Verify deployment on block explorer
 
 ### Production Deployment
 
@@ -354,9 +343,9 @@ Extend your knowledge:
 
 ## Resources
 
-- [pallet-revive Documentation](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/index.html)
+- [Polkadot SDK Documentation](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/index.html)
 - [Solidity Documentation](https://docs.soliditylang.org/)
-- [Hardhat Guides](https://hardhat.org/tutorial)
+- [Ethers.js Documentation](https://docs.ethers.org/)
 - [OpenZeppelin Contracts](https://docs.openzeppelin.com/contracts/)
 - [Ethereum Security Best Practices](https://consensys.github.io/smart-contract-best-practices/)