Wiki style guidelines

Generally the Bisq wiki follows the Wikipedia Manual of Style and conventions from other established wikis like the Bitcoin Wiki.

See exceptions and additions below.

Structure of the wiki

There are three general categories that can be applied to almost every article:

• Concepts
• Procedures/Use Cases
• References

Please keep articles in one of these distinct categories. For example, there's the concept of a data directory and a use-case of switching to a new data directory. Each item should have its own article.

Conventions

Add a table of contents wherever possible

In case an article doesn't automatically include a table of contents, please add one after the introductory text with __TOC__.

Avoid using abbreviations in page titles

Prefer "Deposit transaction" over "Deposit tx".

Prefer wiki headings over plain bold text

Wiki headings appear in the table of contents, but other text doesn't, so it's better to use headings for big ideas—users can simply scan the table of contents for an article and quickly get an idea of what it covers. This tends to be particularly helpful when writing processes, but is good as a general guideline too.

Use code blocks for UI elements

Denote user interface (UI) elements like tabs and buttons with literal markup (e.g., Click Start). Markup for this styling is <code></code>.

Make software screenshots aesthetically consistent

For full screenshots of Bisq, please try to make sure:

• Bisq is at the original window size
• Bisq is in light mode
• Don't include your operating system's window border

These conventions will help screenshots appear more aesthetically consistent across the wiki.

Use consistent markup for images

For including a screenshot of the full Bisq window in an article, please try to use the following conventions:

• Use thumb format
• Align left
• Make 600px wide
• Add a concise caption

Example:

[[File:Find-wallet-seed-words.png|thumb|left|600px|Location of wallet seed words and date.]]

It would be extra nice (but not required) to use the following conventions for marking images:

• Use this arrow
• Make any markup 6px wide in the #ff0000 color

Use gerunds for page titles

Use gerunds for page titles (e.g., "Switching data directories" instead of "Switch data directory" and "Updating trade fees" instead of "Update trade fees").