Differences

This shows you the differences between two versions of the page.

--- writing-guide [May 25, 2026 at 13:29] – Ivan Janevski
+++ writing-guide [May 25, 2026 at 13:38] (current) – Ivan Janevski
@@ Line 1: / Line 1: @@
 # Writing guide
-Every article should preferably start with a main section followed by a few paragraphs.
+**Writing guide** (this article) is a guide to writing articles in this wiki.
+Every article should preferably start with a main section followed by a few paragraphs. The first paragraph should preferably start with the name of the article in bold (just as it did in this article) followed by a few sentences that further describe the concept.
+## Paragraphs
+Paragraphs should describe one main idea in 3-6 sentences. Preferably (though not necessarily so) this idea is better described by an artifact just below the paragraph e.g. a code block, equation or an image. A section should contain 2-5 paragraphs. If there are too many paragraphs, it's fine to open subsections but then they have to contain 2-5 paragraph as well.
 ## Sections
@@ Line 23: / Line 28: @@
 }
 ```
+## Equations
+Equations should be written in LaTeX. Math symbols like greek letters $\alpha,\beta,\gamma$ are fine to embed directly into paragraphs but heavy-duty equations that involve matrices, integrals, fractions, sums and so on should preferably put in their own line. For example the following is a matrix for Pauli $X$ gate
+$$X = \begin{pmatrix} 0 & 1 \\ 1 & 0 \end{pmatrix}$$