summaryrefslogtreecommitdiff
path: root/HACKING
blob: 67791f98eb05ba0643a2d01423bc8ba946753a67 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
gnome-user-docs
===============

This module is for end-user documents with general GNOME applicability 
only. It will be shipped as the gnome-user-docs package.


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

For help on editing documentation, see the following pages:
https://wiki.gnome.org/DocumentationProject/DocProjectDocs

If you want to hack on the documentation, don't forget to Join the GNOME
Documentation Project:
https://wiki.gnome.org/DocumentationProject/Contributing

If you do not have git access, please file patches in Bugzilla:
https://bugzilla.gnome.org/enter_bug.cgi?product=gnome-user-docs


Directory Structure
-------------------

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

In some cases, it may make sense to nest things one level deeper. However,
do not nest things less deep.