-
Notifications
You must be signed in to change notification settings - Fork 83
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
1 changed file
with
104 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,104 @@ | ||
--- | ||
title: Solus Style Guide | ||
summary: Guidance for writing Solus content | ||
--- | ||
|
||
# Solus style guide | ||
|
||
Solus needs a style guide to give clarity to our contributors and a consistent experience for readers. But we don't want to write our own! We surveyed existing style guides, and we picked parts that were more suitable for our content. | ||
|
||
:::note | ||
|
||
Existing help center topics might not follow our style guide yet. | ||
|
||
::: | ||
|
||
## General writing style | ||
|
||
Use the [Google developer documentation style guide](https://developers.google.com/style) for general writing style, grammar, and formatting. | ||
|
||
Some useful pages: | ||
|
||
- [Text formatting summary](https://developers.google.com/style/text-formatting) | ||
- [Procedure](https://developers.google.com/style/procedures) | ||
- [Timeless documentation](https://developers.google.com/style/timeless-documentation) | ||
- [Word list](https://developers.google.com/style/word-list) | ||
|
||
## Linux-specific terms | ||
|
||
If you are unsure of how to use a common linux term, refer to the [Glossary of terms and conventions](https://redhat-documentation.github.io/supplementary-style-guide/#glossary-terms-conventions) from the _Red Hat supplementary style guide for documentation_ | ||
|
||
## Specific guidance | ||
|
||
_In alphabetical order, not order of importance._ | ||
|
||
### Admonitions | ||
|
||
This section is based on the [Red Hat supplementary style guide.](https://redhat-documentation.github.io/supplementary-style-guide/#admonitions). | ||
|
||
Admonitions should draw the reader’s attention to certain information. Keep admonitions to a minimum, and avoid placing multiple admonitions close to one another. If multiple admonitions are necessary, restructure the information by moving the less-important statements into the flow of the main content. See the [Docusaurus documentation](https://docusaurus.io/docs/markdown-features/admonitions) to learn the correct syntax. | ||
|
||
| Type | Description | | ||
| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| Note | Additional guidance or advice that improves product configuration, performance, or supportability | | ||
| Important | Advisory information essential to the completion of a task or default configuration settings. Users must not disregard this information. | | ||
| Warning/Danger | Information about potential system damage, data loss, or a support-related issue if the user disregards this admonition. <br> If available, offer information to avoid the problem in the future or state where to find more information. | | ||
| Tip | Recommendations, suggestions, and alternative methods that might not be obvious. Tips are not essential to using the product. | | ||
|
||
## Code blocks | ||
|
||
Code blocks must indicate the programming language of the code snippet. | ||
|
||
````md | ||
```js | ||
console.log("Hello, world!"); | ||
``` | ||
```` | ||
|
||
### Commands | ||
|
||
- Commands as part of procedures must be inside code blocks with `bash` as the language type. This ensures users get a "copy to clipboard" button. | ||
- When needed, indicate the directory where users need to move before executing the command. | ||
|
||
````md | ||
```bash | ||
cd ~/path/to/directory | ||
sudo somecommand | ||
``` | ||
```` | ||
|
||
### Common Solus terms | ||
|
||
- Solus | ||
- Prefer _Solus_ rather than _Solus Project_. Don't use _Solus OS_ or _Solus Linux_. | ||
- The names of the different editions of Solus are: | ||
- Solus Budgie | ||
- Solus GNOME | ||
- Solus Plasma | ||
- Solus XFCE | ||
- Repositories | ||
- Avoid using terms such as _repo_, or _monorepo_, use the specific repository name instead. | ||
- Example: "The packages repository", instead of "The monorepo". | ||
- Dev Tracker | ||
- Avoid using the term _Dev Tracker_. | ||
- Example: "The packages issue tracker", instead or "The dev tracker" | ||
|
||
### Markdown formatting | ||
|
||
Write content using [markdown formatting](https://www.markdownguide.org/cheat-sheet/), use [Prettier](https://prettier.io/) to enforce consistent formatting. | ||
|
||
## Package Names | ||
|
||
- The name of packages in the Solus repository must use inline code formatting. | ||
|
||
```md | ||
To install `caddy`, use the Software Center or execute the following command: | ||
``` | ||
|
||
- When referring to the name of a product or project, use the name the authors use. | ||
|
||
Examples: _RetroArch_, and _Code::Blocks_ | ||
|
||
### Spelling | ||
|
||
We prefer American spelling over British spelling. When in doubt about the spelling of a word, see the [Merriam-Webster dictionary](https://www.merriam-webster.com/). |