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 Adding a New Project from GitLab
- you write your documentation in RST. See See How To Document
- you follow a few simple policies.