Help:Style: Difference between revisions
Prabuanand (talk | contribs) (created initial page to bring consistent look and feel across all pages in wiki) |
Prabuanand (talk | contribs) m (fixed broken link and rephrased introduction sentence) |
||
| Line 1: | Line 1: | ||
To achieve a consistent look and feel across all pages | To achieve a consistent look and feel across all pages of Alpine Linux wiki, editors must follow the below style guidelines as much as possible. | ||
== Page title and headings == | == Page title and headings == | ||
* Page titles and all headings should use [ | * Page titles and all headings should use [https://en.wikipedia.org/wiki/Letter_case#Sentence_case sentence case]. | ||
* Avoid including '''Alpine Linux''' in headings. | * Avoid including '''Alpine Linux''' in headings. | ||
* Start headings at level 2, and don't skip levels. | * Start headings at level 2, and don't skip levels. | ||
Revision as of 18:09, 12 December 2024
To achieve a consistent look and feel across all pages of Alpine Linux wiki, editors must follow the below style guidelines as much as possible.
Page title and headings
- Page titles and all headings should use sentence case.
- Avoid including Alpine Linux in headings.
- Start headings at level 2, and don't skip levels.
- First-level headings and their formatting is used for article title.
Standard sections
The following sections are recommended on all wiki pages:
=== Prerequisite ===
If there any Prerequisite, it must be properly listed here.
=== "Installation" section ===
The Installation section must appear early in the page.
=== "Configuration" section ===
The Configuration section must follow with detailed sub-headings to handle all sub-topics.
=== "Troubleshooting" section
Troubleshooting section must include common errors that may be encountered by the users.
=== "See also" section ===
Add both internal wiki links and external references relevant to the page in this section.
Page category
Every page should be assigned at least one category from among the list of categories.