summaryrefslogtreecommitdiffstats
path: root/nixos/doc/manual/from_md/development/option-declarations.section.xml
diff options
context:
space:
mode:
Diffstat (limited to 'nixos/doc/manual/from_md/development/option-declarations.section.xml')
-rw-r--r--nixos/doc/manual/from_md/development/option-declarations.section.xml12
1 files changed, 11 insertions, 1 deletions
diff --git a/nixos/doc/manual/from_md/development/option-declarations.section.xml b/nixos/doc/manual/from_md/development/option-declarations.section.xml
index 381163dd7c74..03ec48f35fd7 100644
--- a/nixos/doc/manual/from_md/development/option-declarations.section.xml
+++ b/nixos/doc/manual/from_md/development/option-declarations.section.xml
@@ -94,7 +94,17 @@ options = {
<listitem>
<para>
A textual description of the option, in DocBook format, that
- will be included in the NixOS manual.
+ will be included in the NixOS manual. During the migration
+ process from DocBook to CommonMark the description may also be
+ written in CommonMark, but has to be wrapped in
+ <literal>lib.mdDoc</literal> to differentiate it from DocBook.
+ See the nixpkgs manual for
+ <link xlink:href="https://nixos.org/nixpkgs/manual/#sec-contributing-markup">the
+ list of CommonMark extensions</link> supported by NixOS
+ documentation.
+ </para>
+ <para>
+ New documentation should preferably be written as CommonMark.
</para>
</listitem>
</varlistentry>