DS 016680fcf6 doc: add documentation conventions to keep a consistent style

2024-01-04 15:44:05 -08:00

7.2 KiB

Raw Blame History

Contributing to the Nixpkgs reference manual

This directory houses the sources files for the Nixpkgs reference manual.

Going forward, it should only contain reference documentation. For tutorials, guides and explanations, contribute to https://nix.dev/ instead.

For documentation only relevant for contributors, use Markdown files and code comments in the source code.

Rendered documentation:

The rendering tool is nixos-render-docs, sometimes abbreviated nrd.

Contributing to this documentation

You can quickly check your edits with nix-build:

$ cd /path/to/nixpkgs
$ nix-build doc

If the build succeeds, the manual will be in ./result/share/doc/nixpkgs/manual.html.

devmode

The shell in the manual source directory makes available a command, devmode. It is a daemon, that:

watches the manual's source for changes and when they occur — rebuilds
HTTP serves the manual, injecting a script that triggers reload on changes
opens the manual in the default browser

Syntax

As per RFC 0072, all new documentation content should be written in CommonMark Markdown dialect.

Additional syntax extensions are available, all of which can be used in NixOS option documentation. The following extensions are currently used:

Tables

Tables, using the GitHub-flavored Markdown syntax.

Anchors

Explicitly defined anchors on headings, to allow linking to sections. These should be always used, to ensure the anchors can be linked even when the heading text changes, and to prevent conflicts between automatically assigned identifiers.

It uses the widely compatible header attributes syntax:

## Syntax {#sec-contributing-markup}

Note

NixOS option documentation does not support headings in general.

Inline Anchors

Allow linking arbitrary place in the text (e.g. individual list items, sentences…).

They are defined using a hybrid of the link syntax with the attributes syntax known from headings, called bracketed spans:

- []{#ssec-gnome-hooks-glib} `glib` setup hook will populate `GSETTINGS_SCHEMAS_PATH` and then `wrapGAppsHook` will prepend it to `XDG_DATA_DIRS`.

Automatic links

If you omit a link text for a link pointing to a section, the text will be substituted automatically. For example [](#chap-contributing).

This syntax is taken from MyST.

Roles

If you want to link to a man page, you can use {manpage}`nix.conf(5)`. The references will turn into links when a mapping exists in doc/manpage-urls.json.

A few markups for other kinds of literals are also available:

{command}`rm -rfi`
{env}`XDG_DATA_DIRS`
{file}`/etc/passwd`
{option}`networking.useDHCP`
{var}`/etc/passwd`

These literal kinds are used mostly in NixOS option documentation.

This syntax is taken from MyST. Though, the feature originates from reStructuredText with slightly different syntax.

Admonitions

Set off from the text to bring attention to something.

It uses pandoc’s fenced divs syntax:

::: {.warning}
This is a warning
:::

The following are supported:

Example admonitions require a title to work. If you don't provide one, the manual won't be built.

::: {.example #ex-showing-an-example}

# Title for this example

Text for the example.
:::

Definition lists

For defining a group of terms:

pear
:   green or yellow bulbous fruit

watermelon
:   green fruit with red flesh

Commit conventions

Make sure you read about the commit conventions common to Nixpkgs as a whole.
If creating a commit purely for documentation changes, format the commit message in the following way:
```
doc: (documentation summary)

(Motivation for change, relevant links, additional information.)
```
Examples:
- doc: update the kernel config documentation to use nix-shell
- doc: add information about nix-update-script
  
  Closes #216321.
If the commit contains more than just documentation changes, follow the commit message format relevant for the rest of the changes.

Documentation conventions

In an effort to keep the Nixpkgs manual in a consistent style, please follow the conventions below, unless they prevent you from properly documenting something. In that case, please open an issue about the particular documentation convention and tag it with a "needs: documentation" label.

Put each sentence in its own line. This makes reviewing documentation much easier, since GitHub's review system is based on lines.
Use the admonitions syntax for any callouts and examples (see section above).
If you provide an example involving Nix code, make your example into a fully-working package (something that can be passed to pkgs.callPackage). This will help others quickly test that the example works, and will also make it easier if we start automatically testing all example code to make sure it works. For example, instead of providing something like:
```
pkgs.dockerTools.buildLayeredImage {
  name = "hello";
  contents = [ pkgs.hello ];
}
```
Provide something like:
```
{ dockerTools, hello }:
dockerTools.buildLayeredImage {
  name = "hello";
  contents = [ hello ];
}
```

Use definition lists to document function arguments, and the attributes of such arguments. For example:

# pkgs.coolFunction

Description of what `coolFunction` does.
`coolFunction` expects a single argument which should be an attribute set, with the following possible attributes:

`name`

: The name of the resulting image.

`tag` _optional_

: Tag of the generated image.

    _Default value:_ the output path's hash.

7.2 KiB Raw Blame History Unescape Escape