[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

branch master updated: doc: Document the documentation process.

From: guix-commits
Subject: branch master updated: doc: Document the documentation process.
Date: Thu, 07 Jul 2022 14:41:28 -0400

This is an automated email from the git hooks/post-receive script.

apteryx pushed a commit to branch master
in repository guix.

The following commit(s) were added to refs/heads/master by this push:
     new e103d61485 doc: Document the documentation process.
e103d61485 is described below

commit e103d6148567d2248cd951f2e2507bdaf4914c29
Author: jgart <>
AuthorDate: Sat Jan 15 14:45:22 2022 -0500

    doc: Document the documentation process.
    * doc/contributing.texi (Contributing): Add Writing Documentation section.
    Co-authored-by: Julien Lepiller <>
    Co-authored-by: Matt Trzcinski <>
    Co-authored-by: Fabio Natali <>
    Co-authored-by: Gabor Boskovits <>
    Co-authored-by: Luis Felipe <>
    Signed-off-by: Maxim Cournoyer <>
 doc/contributing.texi | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/doc/contributing.texi b/doc/contributing.texi
index e1902f120f..dcb45ad34c 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -29,6 +29,7 @@ choice.
 * Tracking Bugs and Patches::   Keeping it all organized.
 * Commit Access::               Pushing to the official repository.
 * Updating the Guix Package::   Updating the Guix package definition.
+* Writing Documentation::       Improving documentation in GNU Guix.
 * Translating Guix::            Make Guix speak your native language.
 @end menu
@@ -1779,6 +1780,47 @@ This check can be disabled, @emph{at your own peril}, by 
setting the
 this variable is set, the updated package source is also added to the
 store.  This is used as part of the release process of Guix.
+@cindex documentation
+@node Writing Documentation
+@section Writing Documentation
+Guix is documented using the Texinfo system.  If you are not yet
+familiar with it, we accept contributions for documentation in most
+formats.  That includes plain text, Markdown, Org, etc.
+Documentation contributions can be sent to
+@email{}.  Prepend @samp{[DOCUMENTATION]} to the
+When you need to make more than a simple addition to the documentation,
+we prefer that you send a proper patch as opposed to sending an email
+as described above.  @xref{Submitting Patches} for more information on
+how to send your patches.
+To modify the documentation, you need to edit @file{doc/guix.texi} and
+@file{doc/contributing.texi} (which contains this documentation
+section), or @file{doc/guix-cookbook.texi} for the cookbook.  If
+you compiled the Guix repository before, you will have
+many more @file{.texi} files that are translations of these
+documents.  Do not modify them, the translation is managed through
+@uref{, Weblate}.
+@xref{Translating Guix} for more information.
+To render documentation, you must first make sure that you ran
+@command{./configure} in your source tree (@pxref{Running Guix Before
+It Is Installed}).  After that you can run one of the following
+@item @samp{make doc/} to compile the Info manual.
+      You can check it with @command{info doc/}.
+@item @samp{make doc/guix.html} to compile the HTML version.
+      You can point your browser to the relevant file in the
+      @file{doc/guix.html} directory.
+@item @samp{make doc/} for the cookbook Info manual.
+@item @samp{make doc/guix-cookbook.html} for the cookbook HTML version.
+@end itemize
 @cindex translation
 @cindex l10n
 @cindex i18n

reply via email to

[Prev in Thread] Current Thread [Next in Thread]