************
Introduction
************

Documentation for software-related projects should be written such that it
can be hosted on this XFEL internal Read The Docs server. Specifically, this
implies that:

- you version your documentation on GitLab and add a projec to this server.
  See :ref:`adding_projects`
- you write your documentation in RST. See See :ref:`project/howto_document`
- you follow a few simple policies.