|
|
| Line 29: |
Line 29: |
| ** [[Workgroup:Router]] | | ** [[Workgroup:Router]] |
| ** [[Workgroup:DataScience]] | | ** [[Workgroup:DataScience]] |
|
| |
| == Style ==
| |
| More information about wiki edits: [[Help:Editing]]
| |
|
| |
| === Language ===
| |
|
| |
| NixOS Wiki articles should be written in clear language. To this end, the following considerations apply:
| |
| ; Accessibility: Wiki articles are often the first thing a new user will read about any subject, so they should be accessible to beginners.
| |
| ; Vocabulary: Use the simplest and most conventional words and expressions you can find to get your point across without oversimplifying.
| |
| ; Organization: Keep your text structured in coherent sentences, paragraphs and sections, each with its own clear themes and topics.
| |
| ; Citations: Citations aren't required, but definitely appreciated; when citing code, hardlink to a particular revision.
| |
| ; Attribution: Where external material is quoted or utilized in the article, and/or licensing or common sense demands it, place clear and complete attribution and (where possible) a link.
| |
|
| |
| === Syntax ===
| |
|
| |
| Make sure to:
| |
| * Follow standard capitalization for software, particularly for the Nix ecosystem (NixOS, Nix, Nix Language, Nixpkgs, and Hydra).
| |
| * Use inline <code><nowiki><code></nowiki></code> tags for filenames, paths, commands and command-line tools.
| |
| * Use <code><nowiki><syntaxhighlight lang="nix"></nowiki></code> for code snippets. Change <code>lang=</code> to match the actual language of the code.
| |
| * Use the secondary MediaWiki header (<code><nowiki>== My Section ==</nowiki></code>) for main sections (the primary header should never be used).
| |
|
| |
| === Code ===
| |
|
| |
| Articles can and often should contain plenty of code snippets and blocks. When using code consider the following:
| |
| ; Quantity: Code examples should be minimal, to-the-point, and only used when illustrative of the surrounding text.
| |
| ; Style: Code should be properly indented with clear naming and commenting where necessary.
| |
|
| |
|
| == Tagging articles == | | == Tagging articles == |