Commit graph

5 commits

Author SHA1 Message Date
secure-designer
4390b480d6 user-guides: fix typo in multisig-messaging-system.md and howto_fix_stuck_funds.md 2021-01-30 19:27:22 +00:00
erciccione
f6d0227637
User guides: Add TOC to multisig-messaging-system.md
also remove spaces at the end of the page and duplicate headers
2020-07-21 15:26:08 +02:00
erciccione
4e5143db60
Simplify versioning system for user guides
This new approach doesn't require version numbers and make easier for contributors to understand the status
of the document. There are only 3 states:

- Outdated: The page is outdated and might not work as expected
- Untranslated: The page needs to be translated
- Translation outdated: The page is translated, but the original (English) document has been updated

To mark a guide as outdated, we change the boolean of the front matter entry 'outdated' in /resources/user-guides/GUIDE.
If 'False', the guide is updated. If 'True' all versions of the guide (English included) will show a warning at the bottom
of the page.

The other 2 states are related to the status of the translated pages and we control them from the language-specific
user guides: /_i18n/LANG/resources/user-guides/GUIDE. At the top of the page a snippet will include 2 parameters:

- translated: "yes" if the page is translated, "no" if it's not.
- translationOutdated: "yes" if the translation is outdated, "no" if it's not

This new system aims to be simpler than the precedent, avoiding to compare versioning numbers and using a higher level
system instead (yes, no, True, False). I also removed the middle way status 'only minor changes', because if there are
only minor changes that don't affect the usability of the guide, we don't need to point it out.

The old system was complex and people didn't use it. These changes will hopefully make things easier for translators and
other contributors.
2020-05-31 09:23:16 +02:00
el00ruobuob
b79d046fec
Update kovri link in MMS guide to kovri.io 2019-03-11 19:52:00 +01:00
rbrunner7
3c3f2980a4 MMS (Multisig Messaging System) manual added to user guides 2019-02-15 21:56:36 +01:00