Skip to content
Open
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
257 changes: 91 additions & 166 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,166 +1,91 @@
<p align="center">
<img src="./Basemark.png" alt="Base logo" width="480" />
</p>

<!-- Badge row 1 - status -->

[![GitHub contributors](https://img.shields.io/github/contributors/base/docs)](https://github.com/base/docs/graphs/contributors)
[![GitHub commit activity](https://img.shields.io/github/commit-activity/w/base/docs)](https://github.com/base/docs/graphs/contributors)
[![GitHub Stars](https://img.shields.io/github/stars/base/docs.svg)](https://github.com/base/docs/stargazers)
![GitHub repo size](https://img.shields.io/github/repo-size/base/docs)
[![GitHub](https://img.shields.io/github/license/base/docs?color=blue)](https://github.com/base/docs/blob/main/LICENSE.md)

<!-- Badge row 2 - links and profiles -->

[![Website base.org](https://img.shields.io/website-up-down-green-red/https/base.org.svg)](https://base.org)
[![Blog](https://img.shields.io/badge/blog-up-green)](https://base.mirror.xyz/)
[![Docs](https://img.shields.io/badge/docs-up-green)](https://docs.base.org/)
[![Discord](https://img.shields.io/discord/1067165013397213286?label=discord)](https://base.org/discord)
[![Twitter Base](https://img.shields.io/twitter/follow/Base?style=social)](https://twitter.com/Base)

<!-- Badge row 3 - detailed status -->

[![GitHub pull requests by-label](https://img.shields.io/github/issues-pr-raw/base/docs)](https://github.com/base/docs/pulls)
[![GitHub Issues](https://img.shields.io/github/issues-raw/base/docs.svg)](https://github.com/base/docs/issues)

Base Docs are community-managed. We welcome and encourage contributions from everyone to keep these docs accurate, helpful, and up to date.

> Note: This repository powers the public Base documentation site. Content lives under `docs/`.

## Local development

Prerequisite: Node.js v19+.

1. Clone the repository.
2. Install the Mint CLI to preview documentation changes locally:

```bash
npm i -g mint
```

3. Preview locally (run from the `docs/` directory where `docs.json` lives):

```bash
cd docs
mint dev
```

Alternatively, without a global install:

```bash
npx mint dev
```

### Troubleshooting

- Ensure Node.js v19+ is installed and that you run `mint dev` from the directory containing `docs.json` (usually `docs/`).
- Local preview differs from production: run `mint update` to update the CLI.

## How to contribute

1. **Fork and branch**: Fork `base/docs` and create a descriptive branch for your change.
2. **Edit content in `docs/`**: Follow the structure and style guidelines below. Preview locally with the Mint CLI.
3. **Open a pull request**: Provide a clear summary and links to related pages. The docs team and community will review.

> Tip: Prefer small, focused PRs. Link related guides and references directly in your content.

## Documentation structure

### Core principle: maintain existing structure

> Warning: Do not create new top-level sections. Place all new content within existing folders under `docs/`.

The Base documentation is organized into established sections (for example: `get-started/`, `learn/`, `base-account/`, `base-app/`, `base-chain/`, `cookbook/`, `mini-apps/`, `onchainkit/`). Fit new content into the most relevant existing section.

### Navigation policy

> Note: We generally do not change the global navigation (top-level tabs) or sidebar sections unless there is a clear, broadly beneficial need. Contributions should focus on improving existing pages and adding new pages within current sections.

### Section purpose and placement

- **Quickstart**: End-to-end setup to first success. Keep concise and current.
- **Concepts**: Explanations of components, architecture, and design philosophy.
- **Guides**: Step-by-step, action-oriented tutorials for specific tasks.
- **Examples**: Complete, runnable examples demonstrating real-world usage.
- **Technical Reference**: API/method/component specs with parameters and return types.
- **Contribute**: Information for contributors and process updates.

#### Cookbook scope

- The `cookbook/` section hosts use case-focused guides and patterns, not product-specific documentation.
- Prefer cross-cutting solutions that illustrate how to build on Base across tools and scenarios.

> Warning: Avoid subsection proliferation:
> - Put all guides at the same level within the Guides section.
> - Organize Reference by component/feature, not per use case.
> - Use cross-links instead of adding new structural layers.

## Style and formatting

### Writing style

1. Be concise and consistent; use active voice and second person.
2. Focus on the happy path; mention alternatives briefly where relevant.
3. Use explicit, descriptive headings and filenames.
4. Maintain consistent terminology; introduce abbreviations on first use.

### AI-friendly content

- Use clear, explicit language and link related pages directly.
- Prefer bulleted lists for options/steps when not sequential.
- Name and reference libraries and tools explicitly.
- Use semantic, readable URLs and avoid ambiguous abbreviations.

> Checklist:
> - Would a Large Language Model understand and follow this content?
> - Can an engineer copy, paste, and run the examples as-is?

### Mintlify formatting

- Start main sections with H2 (`##`) and subsections with H3 (`###`).
- Use fenced code blocks with language and optional filename.
- Wrap images in `<Frame>` and include `alt` text.
- Use callouts for emphasis: `<Note>`, `<Tip>`, `<Warning>`, `<Info>`, `<Check>`.
- For procedures, prefer `<Steps>` / `<Step>`.
- For alternatives, use `<Tabs>` / `<Tab>`.
- For API docs, use `<ParamField>`, `<ResponseField>`, and request/response examples.

### Code examples

- Provide complete, runnable examples with realistic data.
- Include proper error handling and edge cases.
- Specify language and filename when helpful.
- Show expected output or verification steps.

## Third-party guides policy

> Warning: We generally do not accept guides that primarily document a third-party product. Exceptions require a clear Base-focused use case and a tight integration with Base products. Simply deploying on Base or connecting to Base Account/Base App is not sufficient.

If your goal is to increase discoverability of your product, please request inclusion on the Base Ecosystem page instead. See the instructions for [updating the Base Ecosystem page](https://github.com/base/web?tab=readme-ov-file#updating-the-base-ecosystem-page).

## Review checklist (before submitting a PR)

- [ ] Fits within existing structure (no new top-level sections)
- [ ] Minimal, necessary subsections only
- [ ] Consistent terminology; abbreviations introduced on first use
- [ ] Code examples are complete, runnable, and validated
- [ ] Cross-links to related guides/examples/references are included
- [ ] Uses Mintlify components and heading hierarchy correctly
- [ ] Accessible images with descriptive `alt` text and frames
- [ ] AI-friendly: explicit, link-rich, and easy to follow

## Submission process

1. Create a PR to `https://github.com/base/docs` with your changes.
2. Include a clear description of the change and impacted pages.
3. Request review from the docs team.
4. Address feedback and iterate.
5. Once approved, changes will be merged and published.

## Publishing changes

The core team will review opened PRs. The SLA is 2 weeks, generally on a first-come, first-served basis outside of urgent changes.

## Storybook for UI components

See `storybook/README.md` for details on local Storybook and component docs.
Документация Base управляется сообществом. Мы приветствуем и поощряем вклад от всех, чтобы эти документы оставались точными, полезными и актуальными.
Примечание: этот репозиторий является основой для общедоступного сайта документации Base. Содержимое находится в папке docs/.

Локальная разработка
Предпосылка: Node.js v19+.
- Клонируйте репозиторий.
- Установите Mint CLI для локального просмотра изменений в документации:
- Просмотр локально (выполнение из каталога docs/, где находится docs.json):
Альтернатива без глобальной установки:
Решение проблем
- Убедитесь, что установлен Node.js v19 + и что вы запускаете mint dev из директории, содержащей docs.json (обычно docs/).
- Локальный просмотр может отличаться от продакшн-версии: запустите mint update, чтобы обновить CLI.
Как контрибьютить
- Форк и ветка: Форкните base / docs и создайте описательную ветку для вашего изменения.
- Редактируйте контент в docs/: следуйте структуре и стилю, описанным ниже. Просматривайте локально с помощью Mint CLI.
- Создайте Pull Request: добавьте четкое резюме и ссылки на связанные страницы. Команда документации и сообщество рассмотрят ваш вклад.
Совет: отдавайте предпочтение небольшим, сфокусированным PR. Добавляйте прямые ссылки на связанные гайды и референсы.

Структура документации
Основной принцип: сохраняйте существующую структуру
Предупреждение: Не создавайте новые разделы верхнего уровня. Поместите весь новый контент в существующие папки под docs/.

Документация Base организована в установленные разделы (например: get-started/, learn/, Base-account/, base-app/, Base-chain/, cookbook/, mini-apps/, onchainkit/). Поместите новый контент в наиболее релевантный существующий раздел.
Политика навигации
Примечание: мы обычно не меняем глобальную навигацию (вкладки верхнего уровня) или боковое меню, если нет четкой, универсальной потребности. Взносы должны быть направлены на улучшение существующих страниц и добавление новых в текущие разделы.

Назначение разделов
- Quickstart: полная настройка к первому успеху. Должен быть кратким и актуальным.
- Concepts: объяснение компонентов, архитектуры и философии дизайна.
- Guides: пошаговые, практические туториалы для конкретных задач.
- Examples: полные, рабочие примеры реального использования.
- Техническая ссылка: спецификации API / методов / компонентов с параметрами и типами возврата.
- Contribute: информация для контрибьюторов и обновления процесса.
Область cookbook
- Раздел cookbook / содержит гайды и шаблоны, ориентированные на кейсы использования, а не на конкретные продукты.
- Отдавайте предпочтение решениям, демонстрирующим, как строить на Base с использованием различных инструментов и сценариев.
Предупреждение: избегайте чрезмерной детализации юнитов:
- Поместите все гайды на один уровень в разделе Guides.
- Организуйте Reference по компоненту / функции, а не по кейсу.
- Используйте перекрестные ссылки вместо создания новых структурных уровней.

Стиль и форматирование
Стиль письма
- Будьте краткими и последовательными; используйте активное состояние и обращение на "ты".
- Фокусируйтесь на основном сценарии; альтернативы упоминайте кратко.
- Используйте четкие, описательные заголовки и имена файлов.
- Придерживайтесь единой терминологии; вводите сокращения при первом использовании.
Контент, дружественный к ИИ
- Используйте четкий, явный язык и добавляйте прямые ссылки на связанные страницы.
- Предпочитайте маркированные списки для опций / шагов, если они не являются последовательными.
- Называйте и упоминайте библиотеки и инструменты явно.
- Используйте семантические, читаемые URL-адреса и избегайте неоднозначных сокращений.
Чеклист:
- Сможет ли большая языковая модель понять и выполнить этот контент?
- Сможет ли инженер скопировать, вставить и запустить примеры как есть?

Форматирование Mintlify
- Основные разделы начинайте с H2 (##), подразделы — с H3 (###).
- Используйте закрытые блоки кода с языком и, при необходимости, именем файла.
- Оберните изображение в <Frame > и добавьте alt текст.
- Используйте callouts для акцентов: <Note>, <Tip>, <Warning>, <Info>, <Check>.
- Для процедур используйте <Steps> / <Step>.
- Для альтернатив - <Tabs> / <Tab>.
- Для API-доков - <ParamField>, <ResponseField > и примеры запросов / ответов.
Примеры кода
- Предоставляйте полные, рабочие примеры с реалистичными данными.
- Включите обработку ошибок и крайние случаи.
- Укажите язык и имя файла, если это полезно.
- Показать ожидаемый результат или шаги проверки.
Политика сторонних гайдов
Предупреждение: мы обычно не принимаем гайды, которые в основном документируют сторонний продукт. Исключения возможны только при наличии четкого кейса использования, ориентированного на Base, и тесной интеграции с продуктами Base. Простое развертывание на Base или подключение к Base Account/Base App недостаточно.

Если ваша цель — повысить видимость продукта, пожалуйста, подайте запрос на включение на страницу экосистемы Base. См. инструкции по обновлению страницы экосистемы базы.
Чеклист перед подачей PR
- [] Вписывается в существующую структуру (без новых разделов верхнего уровня)
- [] Минимальные, необходимые подразделения
- [] Последовательная терминология; сокращения введены при первом использовании
- [] Примеры кода полные, рабочие и проверенные
- [] Добавлены перекрестные ссылки на связанные гайды / примеры / референсы
- [] Используются компоненты Mintlify и правильная иерархия заголовков
- [] Доступные изображения с описательным alt текстом и оберткой
- [] Дружелюбный к ИИ: явный, насыщенный ссылками, легкий для восприятия
Процесс подачи
- Создайте PR к https://github.com/base/docs с вашими изменениями.
- Добавьте четкое описание изменений и страниц, на которые они влияют.
- Запросите просмотр от команды документации.
- Внесите правки по фидбеку.
- После одобрения изменения будет объединено и опубликовано.
Публикация изменений
Основная команда просматривает открытые PR. SLA