This project houses the source files for the Drupal User Guide. It is not a module.

The current HTML version of the User Guide can be viewed at:

If you download this project, you will find PDF, ePub, and Mobi output versions of the User Guide in the "ebooks" folder/directory, as well as the source that the HTML and e-book versions were built from.


The User Guide project was started during the Drupal 8 development cycle by the Documentation Working Group (DocWG), as a community initiative. Members of the community write, edit, and translate the guide, using templates and following guidelines provided by the DocWG.

The User Guide is now completely written and edited in English. It is also being translated into 10 languages, and you can see the in-progress translations of the Guide via links on the Guide pages.



If you have suggestions or comments about the project, especially about templates, guidelines, or project management, please add an issue. You can also add an issue if you find a problem in the guide. There are issue "Components" in this project for project management, guidelines content, guide content, translations, and templates.

Note about branches/versions

We are making "branches" of this project corresponding to Drupal Core versions:

  • We had an 8.x-0.x branch corresponding to Drupal 8.0.x when we started out.
  • There was no 8.1.x version.
  • The first finished English version was 8.x-2.x, corresponding to Drupal Core 8.2.x.
  • The current branch is 8.x-3.x, corresponding to Drupal Core 8.3.x. Translations to 10 languages are in progress on that branch.

Project Information