View source for Help:Style

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 [https://en.wikipedia.org/wiki/Letter_case#Sentence_case sentence case].
* Avoid including '''Alpine Linux''' in headings.
* Start headings at level 2, as first-level heading is used for page title.
* Don't skip levels.

== Section organization ==

Every page should begin with an introductory lead section – a concise summary of the article – which is never divided into sections. The remainder of the article is typically divided into sections. The following sections hedings are recommended on wiki pages:

<Pre>
 === Prerequisite ===

  If there any Prerequisite, it must be properly listed here.

 === Installation ===

  The Installation section must appear early in the page.

 === Configuration ===

  The Configuration section must follow with detailed sub-headings to handle all sub-topics.

 === Troubleshooting ===

  Troubleshooting section must include common errors that may be encountered by the users.

 === See also ===

  Add both internal wikilinks and external references relevant to the page in this section.
</Pre>

== Bulleted and numbered lists ==

* Do not use lists if a passage is read easily as plain paragraphs.
* Use numbers rather than bullets only if:
**a need to refer to the elements by number may arise;
**the sequence of the items is critical;

== Links == 

Make [[Help:Editing#Links|links]] only where they are relevant and helpful in the context: Excessive use of hyperlinks can be distracting and may slow the reader down. Add links only that are worth pursuing.

Check links: Ensure the destination is the intended one and test them.
 
External links should not normally be used in the body of an article and instead Use [[#See also]] section for placing them. Add external links with discretion and do not use wiki for self-promotion.

== Transclusion ==

For content that many be required in multiple pages, consider using [[Help:Editing#Transclusion|Transclusion]]. To identify such pages quickly,  title such pages with '''Include:''' in front of the regular title. For eg: [[Include:Setup-desktop]],  [[Include:Architecture support matrix]] are such pages.

== Category ==

Every page should be assigned at least one [[Help:Editing#categories|category]] from among the [[Special:Categories|categories list]] by placing them at the bottom of the page.

== See also ==
* [[How to write a HOWTO]]
* [https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style Wikipedia Manual of Style]
* [https://wiki.archlinux.org/title/Help:Style Archwiki Help:Style]

[[Category:Wiki]]