iExec Documentation

📋 Prerequisites

• Node.js: Version 22 or higher
• npm: Comes bundled with Node.js
• Vale (optional): For documentation linting and quality checks

⚙️ Configuration

Documentation Quality with Vale

We use Vale to maintain high-quality documentation standards. Vale checks your writing for clarity, consistency, and adherence to our style guidelines, helping us maintain a coherent tone of voice, accurate terminology, and overall editorial quality across the project.

Installing Vale

macOS:

brew install Vale/tap/vale

Linux (Snap):

snap install vale

Windows:

choco install vale

Running Vale Locally

# Download and install external configuration sources
vale sync

# Check all documentation files
vale src/

# Check specific files
vale src/get-started/helloWorld/1-overview.md

# Get detailed output
vale --output=line src/

# Generate comprehensive report with statistics
vale --output=line src/ > vale-report.txt 2>&1

Vale Rules

Our Vale configuration uses the Google & Vale writing style guide, which helps ensure:

• Clear and concise language
• Consistent terminology
• Professional tone
• Accessibility best practices

Environment Variables (Optional)

Some features of the application require environment variables. This configuration is optional and only needed if you plan to work with Hello World pages.

Create a .env file at the root of the project using the provided .env.example as a template:

cp .env.example .env

Then fill in the required values:

VITE_REOWN_PROJECT_ID=your_project_id_here

Getting your VITE_REOWN_PROJECT_ID

To obtain your VITE_REOWN_PROJECT_ID, follow these steps:

1. Go to https://dashboard.reown.com/
2. Create an account if you don't have one already
3. Once logged in, click on "Create Project" or "New Project"
4. Fill in your project information:
   • Project name
   • Description (optional)
   • Website URL (optional)
5. Once the project is created, copy the "Project ID" displayed in the project details
6. Paste this ID in your .env file as the value for VITE_REOWN_PROJECT_ID

🚀 Getting Started

Installation

Install the project dependencies:

npm install

Development Server

Start the development server:

npm run dev

The documentation site will be available at http://localhost:3000 (or the port shown in your terminal).

Building for Production

To build the project for production:

npm run build

🤝 Contributing

We welcome contributions to improve the iExec documentation!

📖 For detailed contribution guidelines, component usage, and best practices, please see our CONTRIBUTING.md guide.

Quick Contribution Steps

1. Fork this repository
2. Clone your fork and install dependencies (npm install)
3. Create a feature branch (git checkout -b feature/your-feature-name)
4. Make your changes and test locally (npm run dev)
5. Submit a pull request

🆘 Support

• 📖 Documentation
• 💬 Discord Community
• 🐛 Issue Tracker