... | @@ -2,10 +2,16 @@ |
... | @@ -2,10 +2,16 @@ |
|
|
|
|
|
This wiki is intended to be used to collect information about the Librem 5 phone, some of which will be used in the developer documentation stored in the associated repository. It is expected that there will also be pieces of information kept in this wiki that do not really fit in the developer documentation.
|
|
This wiki is intended to be used to collect information about the Librem 5 phone, some of which will be used in the developer documentation stored in the associated repository. It is expected that there will also be pieces of information kept in this wiki that do not really fit in the developer documentation.
|
|
|
|
|
|
## Documentation syntax and style
|
|
## Editing this Wiki
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Documentation Syntax and Style
|
|
|
|
|
|
Although this wiki is written in Markdown, the documentation itself is written in [reStructuredText](http://docutils.sourceforge.net/rst.html) because we use the [Sphinx](http://www.sphinx-doc.org/en/stable/) tool to generate the online HTML documentation.
|
|
Although this wiki is written in Markdown, the documentation itself is written in [reStructuredText](http://docutils.sourceforge.net/rst.html) because we use the [Sphinx](http://www.sphinx-doc.org/en/stable/) tool to generate the online HTML documentation.
|
|
|
|
|
|
|
|
### Links
|
|
|
|
|
|
We prefer using references rather than inline links. This means that the text contains marked up words or phrases that refer to a resource elsewhere. The connection between the text and the resource is defined separately. For example:
|
|
We prefer using references rather than inline links. This means that the text contains marked up words or phrases that refer to a resource elsewhere. The connection between the text and the resource is defined separately. For example:
|
|
```
|
|
```
|
|
The development boards for the Librem 5 are built around the `EmCraft i.MX 8M SoM`_,
|
|
The development boards for the Librem 5 are built around the `EmCraft i.MX 8M SoM`_,
|
... | @@ -23,3 +29,9 @@ The `latest documentation`_ for Builder describes the `preferred installation`_ |
... | @@ -23,3 +29,9 @@ The `latest documentation`_ for Builder describes the `preferred installation`_ |
|
method for the IDE.
|
|
method for the IDE.
|
|
```
|
|
```
|
|
We don't want to include definitions for "latest documentation" and "preferred installation" in the global collection because they could clash with other uses of these phrases in links elsewhere in the documentation.
|
|
We don't want to include definitions for "latest documentation" and "preferred installation" in the global collection because they could clash with other uses of these phrases in links elsewhere in the documentation.
|
|
|
|
|
|
|
|
### Titles
|
|
|
|
|
|
|
|
The preferred style is to capitalize verbs ("Editing", "Create"), adjectives ("Large", "New"), nouns ("Board", "Image") but not articles ("the", "a"), conjunctions ("and", "or") and prepositions ("with", "for"). If capitalizing a word makes its meaning unclear, or it refers to a command, then it should be used verbatim (as is) and not capitalized.
|
|
|
|
|
|
|
|
This isn't critical but it makes the documentation a bit more consistent. |
|
|
|
\ No newline at end of file |