Skip to content

docs: enhance README documentation across all applications #1688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 118 additions & 2 deletions apps/base-docs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,119 @@
# Base Docs
# Base Documentation

This the Docusaurus app for the Base docs. You can run the dev server locally with `yarn workspace @app/base-docs dev`.
This is the official documentation site for Base, built using [Docusaurus](https://docusaurus.io/). The documentation covers everything from getting started with Base to advanced development topics.

## ✨ Features

- Comprehensive Base platform documentation
- Interactive tutorials and guides
- API references
- Search functionality powered by Algolia
- Responsive design
- Multi-language support

## 🚀 Getting Started

### Prerequisites

- Node.js (version specified in root `.nvmrc`)
- Yarn package manager
- Git

### Installation

1. **Install Dependencies**
```bash
yarn install
```

2. **Environment Setup**
```bash
cp .env.example .env
```

3. **Start Development Server**
```bash
yarn workspace @app/base-docs dev
```

The site will be available at `http://localhost:3000`.

## 📁 Project Structure

```
apps/base-docs/
├── docs/ # Main documentation content
├── src/ # Source code
│ ├── components/ # React components
│ ├── css/ # Stylesheets
│ └── utils/ # Utility functions
├── static/ # Static assets
├── tutorials/ # Tutorial content
├── base-learn/ # Learning resources
└── scripts/ # Maintenance scripts
```

## 📝 Content Management

### Documentation

- Documentation files are written in MDX format
- Located in the `docs/` directory
- Organized by categories in `sidebars.js`
- Support for code examples, images, and interactive components

### Tutorials

- Tutorial content is in the `tutorials/` directory
- Each tutorial should include:
- Clear objectives
- Step-by-step instructions
- Code examples
- Expected outcomes

## 🔧 Available Scripts

- `yarn dev` - Start development server
- `yarn build` - Build for production
- `yarn serve` - Serve production build locally
- `yarn clear` - Clear build cache
- `yarn write-translations` - Extract translations
- `yarn write-heading-ids` - Update heading IDs

## 🌐 Search Configuration

The documentation uses Algolia for search functionality. Configuration can be found in `algolia.json`.

## 🎨 Customization

- Site configuration: `docusaurus.config.js`
- Navigation structure: `sidebars.js`
- Styling: `src/css/`
- Custom components: `src/components/`

## 🔄 Deployment

The documentation is automatically deployed through our CI/CD pipeline. The deployment configuration can be found in `deploy.yml`.

## 🤝 Contributing

We welcome contributions to the Base documentation! Please read our [Contributing Guidelines](../../CONTRIBUTING.md) before submitting changes.

### Content Guidelines

1. Keep language clear and concise
2. Include practical examples
3. Maintain consistent formatting
4. Update sidebar navigation when adding new pages
5. Test all code examples

## 📄 License

This project is licensed under the terms specified in the [LICENSE](../../LICENSE.md) file.

## 🆘 Support

For questions about the documentation or to report issues:
- Open an issue in the repository
- Join our [Discord community](https://discord.gg/buildonbase)
- Contact the Base team through official channels
106 changes: 97 additions & 9 deletions apps/bridge/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,104 @@
# Base Bridge App

The Base Bridge App is a Next.js app.
The Base Bridge App is a Next.js application that facilitates asset transfers between Ethereum and Base networks. This bridge interface provides a secure and user-friendly way to move assets across chains.

## Getting started
## ✨ Features

```shell
cd apps/bridge
cp .env.goerli.example .env.local
cd ../..
yarn workspace @app/bridge dev
- Cross-chain asset transfers between Ethereum and Base
- Support for multiple networks (Mainnet, Goerli, Sepolia)
- Integration with popular Web3 wallets
- Real-time transaction tracking
- Gas fee estimation

## 🚀 Getting Started

### Prerequisites

- Node.js (version in `.nvmrc`)
- Yarn package manager
- A Web3 wallet (MetaMask, etc.)
- [WalletConnect](https://walletconnect.org/) Project ID

### Installation

1. **Clone and Install Dependencies**
```shell
cd apps/bridge
yarn install
```

2. **Environment Setup**
```shell
# For Goerli testnet
cp .env.goerli.example .env.local
# OR for mainnet
cp .env.mainnet.example .env.local
# OR for Sepolia testnet
cp .env.sepolia.example .env.local
```

3. **Configure WalletConnect**
- Create a project at [WalletConnect](https://walletconnect.org/)
- Add your project ID to `.env.local`:
```
WALLET_CONNECT_PROJECT_ID=your_project_id_here
```

4. **Start Development Server**
```shell
cd ../..
yarn workspace @app/bridge dev
```

## 🔧 Configuration

### Environment Variables

The app supports different configurations for various networks:
- `.env.mainnet.example` - Ethereum mainnet configuration
- `.env.goerli.example` - Goerli testnet configuration
- `.env.sepolia.example` - Sepolia testnet configuration

Copy the appropriate example file and configure the following key variables:
- `WALLET_CONNECT_PROJECT_ID` - Your WalletConnect project ID
- `NEXT_PUBLIC_ENABLE_TESTNETS` - Enable/disable testnet support
- Network RPC endpoints and chain IDs

## 🏗 Project Structure

```
apps/bridge/
├── src/ # Source code
│ ├── components/ # React components
│ └── utils/ # Utility functions
├── pages/ # Next.js pages
├── public/ # Static assets
├── chains.ts # Chain configurations
└── assets.ts # Asset configurations
```

### Wallet Connect Project ID
## 📦 Available Scripts

- `yarn dev` - Start development server
- `yarn build` - Build for production
- `yarn start` - Start production server
- `yarn lint` - Run linter

## 🔒 Security

- Always verify transaction details before confirming
- Use official RPC endpoints
- Keep your private keys secure
- Never share sensitive information

## 🤝 Contributing

Please read the [Contributing Guidelines](../../CONTRIBUTING.md) before submitting any pull requests.

## 📄 License

This project is licensed under the terms specified in the [LICENSE](../../LICENSE.md) file.

## 🆘 Support

Additionally you will need to create a [Wallet Connect](https://walletconnect.org/) project and add the project ID to the `.env.local` file for the `WALLET_CONNECT_PROJECT_ID` env var.
For support and questions about using the Base Bridge, please visit our [Documentation](https://docs.base.org) or join our [Discord community](https://discord.gg/buildonbase).
85 changes: 84 additions & 1 deletion apps/web/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,86 @@
# Base Marketing Site

The Base marketing site is a Next.js app. You can run the dev server locally with `yarn workspace @app/web dev`.
The Base marketing site is a modern web application built with Next.js, providing a robust and performant user experience. This application serves as the main marketing and information platform for Base.

## 🚀 Quick Start

1. **Prerequisites**
- Node.js (version specified in `.nvmrc`)
- Yarn package manager
- Git

2. **Installation**
```bash
# Install dependencies
yarn workspace @app/web install

# Copy environment variables
cp .env.local.example .env.local
```

3. **Development**
```bash
# Start development server
yarn workspace @app/web dev
```

4. **Production**
```bash
# Build for production
yarn workspace @app/web build

# Start production server
yarn workspace @app/web start
```

## 🛠 Tech Stack

- **Framework**: Next.js
- **Styling**: Tailwind CSS
- **3D Graphics**: Three.js with React Three Fiber
- **State Management**: React Query
- **Web3**: wagmi, viem, ethers
- **Testing**: Jest
- **Analytics**: Datadog

## 📁 Project Structure

```
apps/web/
├── app/ # Next.js app directory
├── contexts/ # React context providers
├── pages/ # Next.js pages
├── public/ # Static assets
├── src/
│ ├── components/ # React components
│ └── utils/ # Utility functions
├── scripts/ # Build and maintenance scripts
└── tracer/ # Datadog tracer configuration
```

## 🔧 Available Scripts

- `yarn dev` - Start development server
- `yarn build` - Build for production
- `yarn start` - Start production server
- `yarn test` - Run tests
- `yarn lint` - Run linter
- `yarn analyze` - Analyze bundle size
- `yarn update-contributors` - Update contributors list
- `yarn fetch-mirror-blog` - Fetch latest blog posts

## 🔑 Environment Variables

Copy `.env.local.example` to `.env.local` and configure the required environment variables before running the application.

## 📚 Documentation

For more detailed documentation about the Base platform, visit the [Base Documentation](https://docs.base.org).

## 🤝 Contributing

Please read the [Contributing Guidelines](../../CONTRIBUTING.md) before submitting any pull requests.

## 📄 License

This project is licensed under the terms specified in the [LICENSE](../../LICENSE.md) file.