HACKING 894 Bytes
Newer Older
1 2 3
gnome-user-docs
===============

4
This module is for end-user documents with general GNOME applicability 
Piotr Drąg's avatar
Piotr Drąg committed
5
only. It will be shipped as the gnome-user-docs package.
6 7 8 9 10 11


Documentation for Doc Writers
-----------------------------

For help on editing documentation, see the following pages:
Piotr Drąg's avatar
Piotr Drąg committed
12
https://wiki.gnome.org/DocumentationProject/DocProjectDocs
13 14 15

If you want to hack on the documentation, don't forget to Join the GNOME
Documentation Project:
Piotr Drąg's avatar
Piotr Drąg committed
16
https://wiki.gnome.org/DocumentationProject/Contributing
17

18 19
Merge requests can be created in GNOME Gitlab:
https://gitlab.gnome.org/GNOME/gnome-user-docs/merge_requests
20 21 22 23


Directory Structure
-------------------
24 25

Please respect the directory structure:
26
  gnome-user-docs/<docname>/<locale>/<docname>.xml
27 28
  gnome-user-docs/<docname>/<locale>/figures/

Piotr Drąg's avatar
Piotr Drąg committed
29
In some cases, it may make sense to nest things one level deeper. However,
30
do not nest things less deep.