Category:Pedias: Difference between revisions

Revision as of 17:20, 29 August 2017

Discussions are understanding-oriented articles aimed at explaining a particular topic. They are encyclopedic, intended to provide an overview of the subject at hand, illuminating the big picture and various perspectives of it. A discussion article might be read casually for leisure, rather than being used as reference while coding.

Canonical Forms

While in general, discussion articles can take a wide variety of forms, certain types of articles recur in the NixOS wiki and warrant specific formats. For these we provide canonical forms, recommended templates for structuring these types of discussion articles.

Software

Introduction: a general overview

Usage: a practical overview of different approaches to installing, configuring and operating the software, linking to more comprehensive guides.

Internals: a theoretical overview of the internal architecture of the software, including critical files and directories, processes and objects.

Development: a project overview for potential contributors, including an overview of the source-code directory structure, development process, issue tracking and the developer community.

History: a historical overview of the software, including an overview of the origins and past development of the software, and the broader historical context, such as precedents and antecedents.

Pages in category "Pedias"

The following 20 pages are in this category, out of 20 total.

@@ Line 1: / Line 1: @@
-Discussions are ''understanding-oriented'' articles aimed at explaining a particular topic. They are intended to provide an overview of the subject at hand, illuminating the big picture and various perspectives of it. A discussion article might be read casually for leisure, rather than being used as [[:Category:Reference|reference]] while coding.
+Discussions are ''understanding-oriented'' articles aimed at explaining a particular topic. They are encyclopedic, intended to provide an overview of the subject at hand, illuminating the big picture and various perspectives of it. A discussion article might be read casually for leisure, rather than being used as [[:Category:Reference|reference]] while coding.
+==Canonical Forms==
+While in general, discussion articles can take a wide variety of forms, certain types of articles recur in the NixOS wiki and warrant specific formats. For these we provide ''canonical forms'', recommended templates for structuring these types of discussion articles.
+===Software===
+# ''Introduction'': a general overview
+# ''Usage'': a practical overview of different approaches to installing, configuring and operating the software, linking to more comprehensive guides.
+# ''Internals'': a theoretical overview of the internal architecture of the software, including critical files and directories, processes and objects.
+# ''Development'': a project overview for potential contributors, including an overview of the source-code directory structure, development process, issue tracking and the developer community.
+# ''History'': a historical overview of the software, including an overview of the origins and past development of the software, and the broader historical context, such as precedents and antecedents.