Help:Style

From Alpine Linux
Revision as of 18:02, 12 December 2024 by Prabuanand (talk | contribs) (created initial page to bring consistent look and feel across all pages in wiki)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

To achieve a consistent look and feel across all pages, Alpine Linux wiki aims to follow the below style guidelines.

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.

See also

How to write a HOWTO