This repository contains all documentation for the Decentraland ecosystem, organized as a GitBook-powered monorepo with multiple documentation spaces.

This repository hosts four separate GitBook spaces, each with its own purpose and audience:

Documentation for Decentraland users and players. Covers gameplay, avatars, marketplace, DAO participation, and in-world features.

• Audience: End users, players
• Topics: Getting started, blockchain integration, DAO, marketplace, in-world features
• GitBook Space: player

Complete guide for content creators building experiences in Decentraland. Includes Scene Editor, SDK7, wearables, emotes, and 3D modeling.

• Audience: Scene creators, wearable designers, game developers
• Topics: Scene Editor, SDK7, wearables, emotes, 3D modeling, publishing
• GitBook Space: creator

Technical documentation for developers contributing to Decentraland's open-source codebase.

• Audience: Core developers, open-source contributors
• Topics: Architecture, authentication, content system, scene runtime, communications, testing standards
• GitBook Space: contributor

Comprehensive API documentation for all Decentraland backend services.

• Audience: Developers integrating with Decentraland services
• Topics: RESTful APIs, authentication, service endpoints, data models
• GitBook Space: apis

docs/
├── README.md                    # This file
├── .gitbook.yaml               # GitBook configuration (root)
│
├── player/                      # Player documentation space
│   ├── README.md               # Player landing page
│   ├── SUMMARY.md              # Player navigation/sidebar
│   ├── images/                 # Player images
│   └── ...                     # Player content pages
│
├── creator/                     # Creator documentation space
│   ├── README.md               # Creator landing page
│   ├── SUMMARY.md              # Creator navigation/sidebar
│   ├── images/                 # Creator images
│   └── ...                     # Creator content pages
│
├── contributor/                 # Contributor documentation space
│   ├── README.md               # Contributor landing page
│   ├── SUMMARY.md              # Contributor navigation/sidebar
│   ├── images/                 # Contributor images
│   └── ...                     # Contributor content pages
│
└── apis/                        # API reference space
    ├── README.md               # APIs landing page
    ├── SUMMARY.md              # APIs navigation/sidebar
    └── ...                     # API documentation pages

This repository uses GitBook's GitHub Sync to automatically publish documentation changes.

1. Write: Contributors edit markdown files in this repository
2. Review: Changes are reviewed via GitHub Pull Requests
3. Merge: Approved changes are merged to the main branch
4. Deploy: GitBook automatically syncs and publishes the updated documentation

Each documentation space has its own .gitbook.yaml configuration file (or shares the root configuration) that defines:

• Root directory: Where the documentation lives (e.g., player/, creator/)
• Structure: Entry point (README.md) and navigation (SUMMARY.md)
• Redirects: URL redirects for moved pages (optional)

Example .gitbook.yaml:

root: ./player/

structure:
  readme: README.md
  summary: SUMMARY.md

✅ Every merge to main triggers an automatic deployment

When you merge a pull request to the main branch:

1. GitHub notifies GitBook via webhook
2. GitBook pulls the latest changes
3. GitBook rebuilds and publishes all affected spaces
4. Changes are live within minutes

• Use standard GitHub Flavored Markdown
• GitBook supports additional features:
  • {% hint style="info|warning|danger|success" %} for callout boxes
  • {% embed url="..." %} for embedded content (videos, etc.)
  • Mermaid diagrams with triple backtick code blocks

Each space has a SUMMARY.md file that defines the sidebar navigation:

# Table of contents

* [Welcome](README.md)

## Section Name

* [Page Title](path/to/page.md)
* [Another Page](path/to/another.md)
  * [Nested Page](path/to/nested.md)

GitBook Limitations:

• Maximum 2 levels of nesting (groups and pages)
• Groups are defined by ## headings
• Nested items use indentation

Store images in the images/ directory within each space:

player/images/
creator/images/
contributor/images/
apis/images/

Reference images using relative paths:

![Alt text](images/subfolder/image.png)

1. Clone the repository

   git clone https://github.com/decentraland/docs.git
   cd docs

2. Create a branch

   git checkout -b feature/your-improvement

3. Make changes

   • Edit markdown files in the appropriate space
   • Add images to the images/ directory
   • Update SUMMARY.md if adding/removing pages

4. Test locally (optional)

   • Preview markdown files in your editor
   • Or use GitBook's local preview

5. Submit a pull request

   git add .
   git commit -m "docs: Description of changes"
   git push origin feature/your-improvement

6. Preview your changes

   • When you open a PR to the main branch, GitBook automatically generates a preview deployment
   • Look for the GitBook check in the PR status — it will include a link to preview your changes
   • Use this preview to verify formatting, links, and overall presentation before requesting review

Every pull request to main triggers GitBook's preview integration:

This preview feature ensures that documentation changes can be thoroughly reviewed in their final rendered form before going live.

• Live Documentation: docs.decentraland.org
• GitBook: Decentraland GitBook Organization

This documentation is licensed under the Apache License 2.0.