As described in the VuePress documentation, we can add the wasabi logo in the navbar like this:

// .vuepress/config.js
module.exports = {
  themeConfig: {
    logo: '/assets/img/logo.png',
  }
}

ToDo

• navbar logo
• favicon

As suggested in the VuePress documentation, each markdown file can have some meta data in yaml format at the top of the file. This can include upon others a description and keywords. I'm not entirely sure how this will affect SEO only for the internal search box, or also for duck duck go searches.

As example the /FAQ-UseWasabi.md:

---
meta:
  - name: description
    content: Frequently Asked Questions how to use Wasabi Wallet.
  - name: keywords
    content: faq how-to use wasabi bitcoin wallet generate load receive send history coinjoin hardware settings coin-control 
---

We should be coherent with the spelling and formatting throughout the documentation.

So, which is it?

1. Coin Join
2. CoinJoin
3. coin join
4. Coinjoin
5. Coin-Join

[any other options?]

Problem

The knowledge archive is growing and growing, and there are many opportunities where a cross reference is needed. When linking manually, then this is restricted to linking to headers, and only one at a time. I'd like to see all the references in the entire docs of a given word. We need to improve the search engine, similar issues are #38 & #40.

Solution

Is there a way to show the results of a search when hovering over a text?
For example when there is:
This is why Wasabi uses [BIP-158 block filters] to ensure [network level privacy], as good as running a [full node].
then for each the brackets, show a hyperlinked list of all the files where this word is referenced. Keep this list up to date as new documentation is added.

I have no clue is there already exists a plugin or functionality for this, and how much work this is to integrate or build manually.

I'm sure there are other ways to achieve a similar goal, so this issue is open for conversation and suggestion!

I'm a bit confused about the nuances of how to properly edit the sidebar menu. So far, I've edited the /docs/.vuepress/config.toml but there are also config_json.js and config_yaml.yaml, and it seems that the latter two are not updated. There should probably be a contributors guide in the WasabiDoc/README.md with the details.

So far, the sidebar has hyperlinks to the markdown files, but it does not show the sub-headers within the file. For some [but not all] the files I think this is a good addition, for example the FAQ should show the questions in a dropdown. I don't really understand the configuration guide of the VuePress Documentation on Sidebar...

Here the current config.toml:

    # FAQ Wasabi sidebar
    # ----------------------------------------
    [[themeConfig.sidebar."/FAQ/"]]
    title = ""
    collapsable = false
    children = [
        "/FAQ/",
        "/FAQ/FAQ-Introduction.md",
        "/FAQ/FAQ-Installation.md",
        "/FAQ/FAQ-UseWasabi.md",
        "/FAQ/FAQ-GeneralBitcoinPrivacy.md",
        "/FAQ/FAQ-Contribution.md",
    ]

Several peers have written great articles and posts about Wasabi.

Should we import the text of them directly into the documentation so that the knowledge archive is more and more thorough?

Or should we only summarize them and link to the original?

For example, Nopara has this great article about Bitcoin Core vs Wasabi Wallet — Network Level Privacy. Should we copy the text into a NetworkPrivacy.md and link it in Load Wallet? Or should we break up and summarize the content into separate topics?

There is an official plugin to add a Jump Back to Top function on each side. I think this is especially useful for Wasabi Doc because there are long files, and a table of content up top.

I suggest we implement this, what do you think?

#47 #48 are also plugin, so implementation might be batched.

Please know that you are opening an issue in the Wasabi documentation repository.
If you have an issue regarding the software specifically, please open an issue in the main Wasabi repository.

What is the general context of your question?

Please explain which general pillar your question is about.
There are many different topics covered in the Wasabi documentation, so it's good to start with a general description of your question.

• About general Bitcoin privacy and why Wasabi is important.
• About the nuances of how to properly use Wasabi and privacy best practices.
• About how to contribute to Wasabi and to help the project grow.

What is your question?

Everything has been running well for me for several days. Today, I made another deposit and things began running but after about an hour I got the message saying: "The coordinator banned this coin from participation until 2019-08-24 :17:20." All coins are flagged banned except the zerolink change. That time passes and I still remain banned. Nothing about this in the docs. Please advise

#126 @nidkil opened an issue that should be asked in the main repository.
I think we should make it clear that issues and PRs open in this repository must be documentation related.

It attempts to take you to: https://docs.wasabiwallet.io/FAQ-UseWasabi.html#coinjoin it should be: https://docs.wasabiwallet.io/FAQ/FAQ-UseWasabi.html#coinjoin

We have many questions and good answers in this great FAQ spearheaded by @6102bitcoin.

For the purposes of this new repository, I suggest that we copy the BTCPay doc structure for the FAQ:

• a separate folder FAQ
• a README.md with the structure and links to every question
• several FAQ-topic.md files that each contain the hyperlinked structure as well as all the questions and answers of that specific topic

The topics might include:

• general Bitcoin privacy
• introduction to Wasabi
• installation of Wasabi
• use of Wasabi
• contribution

Currently in the side bar menu, every header has the font and color, the # is a tiny bit larger than the ## & ### headers, and they are indented a little.

Can we also add a color differentiation, maybe make the # bold and underlined?

There is an official plugin to provide a progress bar of how far the document is read. This might be a nice touch and make everything look a bit more pertty.
I think this is useful for Wasabi Doc because the files can get rather long, and a reference of how much is still left is good.

I suggest we implement this, what do you think?

#46 #47 are also plugin, so implementation might be batched.

I'm trying to connect wasabi to my own full node. The connection seems to be established but data is displayed as ######. Any advise?

Wasabi version: 1.1.6
OS: Manjaro 18.0.4
Full node: 0.18.0 on Ubuntu 18.04

State a recommended version for which version of Node.Js for building the docs locally

This is an open source archive of knowledge, and the goal is to have both users and developers collaborate to ensure that Wasabi is properly explained. We already have many contributions [for example the FAQ], and we will continue to see new peers joining the effort.

The question is

How do we properly attribute and thank the creators of the specific information?

Git helps here a lot, it's clear who has done what commit. However, for example the FAQ was written by several others, yet I committed it to this new repository, thus obfuscating who actually created it.

I don't think it is a good idea to have attribution directly in the doc, meaning that every line has a footnote with whom has written it. This will clutter the doc and GitBook.

How about we have a separate file that lists all the contributors, we could maybe link to the specific contributions they've made, but that will be a pain to keep up to date...

Ultimately, I'm not sure, so this issue is open to start the conversation :)

We already have MANY amazing videos that explain the nuances of Wasabi, and we should include them in this documentation.
Right now they are only hyperlinks that lead to the external youtube site.

How can vidoes be embedded in VuePress, so that it shows the player in the docs it self?

What is the general context of your question?

https://docs.wasabiwallet.io/using-wasabi/InstallPackage.html#windows

We should replace the pictures with nopara's PGP by pictures with zkSNACKs' PGP.

And why the docs website is not in dark mode?

I am not sure if the use of wasabikas or peers or similar words in the documentation is really helpful. I think we need to be very simple and clear when we are trying to explain things.

There is no description of what a Lurking Wife mode is in the docs. There are many questions about this.

In every page on the vuepress html it has a button with Edit this page and an external link that is supposed to land in the GitHub at the edit of this specific markdown.

However, the link is broken, it is
https://github.com/zkSNACKs/WasabiDoc/edit/master/using-wasabi/DeterministicBuild.md
but should be with the /docs/
https://github.com/zkSNACKs/WasabiDoc/edit/master/docs/using-wasabi/DeterministicBuild.md

I'm not sure exactly where to fix this...

How can I format the position of a picture?
For example, how can it be nested on the side of a paragraph with breaking lines at the boarders?

This was already discussed in #8, but I think a separate issue is good.

@sourcecred is a powerful tool to get a contribution score to all the many Wasabikas - not just commits with lines added, but many many more customizable attributes. This is very powerful, also as help to spread out the bounty rewards.

This thread has a thorough question, and a very very awesome and detailed answer by @decentralion.

Next step ToDo's

• Create new WasabiCred repo in the @zkSNACKs organization.
• Setup SourceCred in this repo
• Host the result on a GitHub page
• Link the result in the Dojo

General Description

In the FAQ page here there is an statement that says: "If a user has a local Bitcoin node running, Wasabi will attempt to broadcast transactions from there."

That is incorrect. Currently, local node is used only for getting blocks.

Screenshots

The question is simple:

Do you like your eyes bleeding?

If the answer is no, then the only logical solution is to make the docs in dark mode.

Why Dark Mode?

• A paper is white by default, thus we use black inc to write. A screen is black by default, thus we use white pixels to write.
• The high contrast of dark background and white text is a lot easier to read.
• Wasabi GUI is already dark mode.
• Bitcoin is already boiling the oceans, so we should save energy, and dark pixels need less electricity than white ones.

Why White Mode?

• It might be an adventure to be blind due to white screen radiation.
• Education is not important, so nobody needs to read the docs anyway.
• Babies are dying.

Comparison

Looks nice, right? [The button should have a different color]

Sorry for making your eyes cry...

Easy to read, right? [The highlighted links will be the same color, this is a bug in my dark mode plugin]

Yeah, you don't want to continue reading, right?

Consideration

It is possible, although related to a lot of development and extra code, to have a toggle to switch between white and dark mode. Here it would be important to remember the setting in the last session, which is again more code...

Let's see what the community says.

When visiting the package install instructions on mobile, then the tor endpoint .onion is very long and has no line break. this means that it is possible to scroll to the left, which is not possible on other sites without such a long link.

The message boxes have the same background and text color. For example at the top of the address reuse page.

:::tip
foo
:::

:::warning
foo
:::

We should add the menu (which is on the left sidebar on Desktop verison) under every chapter on Mobile version:

• Why Wasabi
• Using Wasabi
• Building Wasabi
• FAQ

Essentially, when the end user enters any 'main' page, it displays nothing except a small description and is forced to open the menu to see the actual content:

Desktop version:

General Description

There is a trailing ::: appearing at the end of the "Why aren't there smaller equal denomination outputs like 0.05 BTC?" section

Screenshots

For example the table in the dojo, every second line is white background and white text. This should be fixed so that all the background is dark, but it might still be good to have a slightly different shade with every other line?

https://github.com/zkSNACKs/WalletWasabi/blob/master/WalletWasabi.Documentation/Guides/InstallInstructions.md

https://github.com/zkSNACKs/WalletWasabi/blob/master/WalletWasabi.Documentation/Guides/DeterministicBuildGuide.md

@MaxHillebrand This is important! These links shall not be broken!

According to the VuePress documentation we can configure the layout and theme of the documentation very thoroughly. So I suggest that we make it fitting to the new WasabiWallet.io theme.

Same logo, colors, font, etc.

We can also consider if it should look similar like the application itself, with that dark mode [yes plz sir!] and blue highlights.

I remember that there were efforts to change the website, and I'm not sure what the latest is on this... This might change some of the branding, and we can easily adapt to this.

[Edited, now we're using VuePress, not GitBook]

Three Pillar Structure

The main documentation should have a three pillar structure, guiding different types of readers to the relevant information. Each pillar is linked in the top right menu bar, and with a unique structure, maybe even unique visual design.

• Why Wasabi
• Using Wasabi
• Building Wasabi

Why Wasabi

is for those who are relatively new to Bitcoin and privacy, here we explain what problem exists and why this is important to fix it. This is the introduction to the over-arching reason why we are so enthusiastic about Bitcoin in general and Wasabi specifically.

Using Wasabi

is for those who seek to understand the nuances of Wasabi and how they can use this tool to reclaim and protect their privacy. Here we have a step by step guide to all the aspects, starting at beginner level, all the way up to power user features and advanced privacy best practices.

Building Wasabi

is for those who want to contribute to this awesome project. I don't like calling it Developing Wasabi, because I think that there are many more contributions needed than "just" code. So this will cover all different ways one can support Wasabi.

FAQ

In addition to this main documentation, there should be a FAQ where specific questions are answered with linked reference to the main documentation. This is for all the users who need a precise answer to a common question, and this will be especially useful for quick-links in peer support and for the VuePress search function.

Directory Structure

These are the files and the directory structure as of the time of writing this issue - there will be of course additional files added, changed and removed.

WasabiDoc
|-README.md
|-CNAME
|-deploy.sh
|-LICENSE
|-node_modules
|-package.json
|-package-lock.json
|+docs
  |-README.md
  |+why-wasabi
     |-README.md
     |-WhyPrivacyImportant.md
     |-BitcoinPrivacy.md
     |-GettingStarted.md
     |-IntroWasabi.md
     |-10Commandments.md
  |+using-wasabi
     |-README.md
     |-InstallPackage.md
     |-BuildSource.md
     |-DeterministicBuild.md
     |-ClientDeployment.md
     |-BackendDeployment.md
     |-PasswordFinder.md
     |-PayToEndPoint.md
  |+building-wasabi
     |-README.md
     |-TechnicalOverview.md
     |-ContributionChecklist.md
     |-Dojo.md
     |-ToDo.md
     |-CodingConventions.md
     |-DemoGuide.md
     |-ContributionGame.md
     |-Security.md
     |-CodeCoverage.md
     |-ManualTesting.md
     |-HardwareWalletTestingGuide.md
     |-HowToDebug.md
     |-Ports.md
  |+FAQ
     |-README.md
     |-FAQ-GeneralBitcoinPrivacy.md
     |-FAQ-Introduction.md
     |-FAQ-Installation.md
     |-FAQ-UseWasabi.md
     |-FAQ-Contribution.md

Each folder contains a README.md with an introduction and summary to the topic. For now they also contain a list with all the files and sub headers, but this might be removed later since it can be linked in the left menu. Each topic will have a separate mark down file in the folder, so that it can be edited self-contained, and that it is a new page in the VuePress.

Questions:

• Can there be one mark down file that is represented in two different pillars?

Next Steps:

• The above proposal is implemented in the work in progress PR #32
• Change the left menu so that each pillar has the file and sub-headers in there
• Triple check all the hyperlinks are working
• Add an introduction to the each README.md

Hi,

I have installed Wasabi Wallet on Manjaro 18.0.4 and I'm getting the following error when starting ./wassabee:

[nidkil@nidkil-manjaro WasabiLinux-1.1.6]$ ./wassabee 
2019-08-09 02:49:27 INFO 1c18b5fb-e097-4621-b688-f9a37c89228a: Wasabi GUI is starting...
2019-08-09 02:49:27 CRITICAL Program: System.Exception: XOpenDisplay failed
   at Avalonia.X11.AvaloniaX11Platform.Initialize(X11PlatformOptions options)
   at Avalonia.Controls.AppBuilderBase`1.Setup()
   at Avalonia.Controls.AppBuilderBase`1.Start[TMainWindow](Func`1 dataContextProvider)
   at WalletWasabi.Gui.Program.Main(String[] args)
2019-08-09 02:49:27 INFO 1c18b5fb-e097-4621-b688-f9a37c89228a: Wasabi GUI stopped gracefully.

Unhandled Exception: System.Exception: XOpenDisplay failed
   at Avalonia.X11.AvaloniaX11Platform.Initialize(X11PlatformOptions options)
   at Avalonia.Controls.AppBuilderBase`1.Setup()
   at Avalonia.Controls.AppBuilderBase`1.Start[TMainWindow](Func`1 dataContextProvider)
   at WalletWasabi.Gui.Program.Main(String[] args)
   at WalletWasabi.Gui.Program.Main(String[] args)
   at WalletWasabi.Gui.Program.<Main>(String[] args)
Aborted (core dumped)

Any suggestions how to solve this?

License button on the side bar shouldn't say /building-wasabi/LICENSE.html

Problem

Right now the link preview text shows always the same, regardless what link is used. This is unspecific and does not give an accurate preview of what the linked content actually is.

Solution

Is it possible to give a more precise preview, either for the specific markdown file [in this case a summary of the BIP.md file] or even better, for the specific header within the markdown file [in this case a summary of BIP158].

1. the links in the header don't work ("How to install Wasabi on Windows" etc give out a 404)

2. for OSX, I needed to preface the commands with sudo before the gpg2 command (it occurs in steps 3 and 5 in the OSX section).

3. I don't like the "Every time you download and install Wasabi you MUST verify the PGP signature" pre-face for the instructions. I assume the majority of users won't bother with verifications and a lot of them might skip the installation if they see something that they don't understand. Of course there's a trade off (do we want to be the avg user to be more educated at the risk of discouraging lots of people from trying out Wasabi VS having a larger base of users but many of whom don't verify the keys). In my opinion it should be rephrased to something like "It is strongly recommended to verify the signatures in order to maximize your security" instead of "you must verify signatures before you can install Wasabi".
   Just my 2 cents :)

the config.js file has sidebarDepth: 2 for all the pillars, including the FAQ, I also tested with adding this header to the FAQ files:

---
sidebarDepth: 2
---

But regardless, the FAQ-Contribution.md, FAQ-Installation.md, FAQ-Introduction.md files do not show the headers with ## or ### in the sidebar.

This bug comes up when there are only # and ### headers in the file, and no ## headers. Thus it can be fixed when adding at least one ## headers to the file. Yet is there a proper fix so that it does diplay ### headers when there are no ## headers?

As mentioned in the original issue, we will start to use GitBook to build the static website of this documentation repository.
@thunder-b has already build test version of a repository.

ToDo

@thunder-b, can you please make a PR with the GitBook setup for this repo? 😘

As described in the VuePress Documentation, there is an automated tool to generate a table of contents. When we input [[toc]] anywhere in the markdown, it will automatically populate a hyper-linked bullet-point table of contents of the headers [default level 2 & 3] in this file. It can be configured in markdown.toc

Pro

• Easy to input, literally just [[toc]].
• Automatic update, seems like this is set it and forget it.
• Easy consistency across all the files.

Con

• Takes the header name, and cannot give extra context, like I've so far done in the hand-made ToC.
• Sub-headers might not want to be integrated in a specific file, not sure how in depth this can be customized.

Question

Should we continue to do a manual table of content in the files that need it, or should we work with this automated feature?

The font size of the top right nav bar should be increased a bit.

We might also increase the general font size?

Also note the trick zkSNACKs/WalletWasabi#2323 (comment)

I would love an explanation of this. I do not really get it.
The title says What do you need to get the keys? but reading that do not answer that question.

We already have some Wasabi info-graphics, and will most certainly create more. Further, we will have several screenshots of Wasabi in the documentation.

Thus we need to implement the infrastructure to properly store the images in the repo and display the images in GitBook.

I'm not sure what is best practice, maybe @thunderbiscuit knows?

https://github.com/PulpCattel/Tails-BitcoinCore-Wasabi

Problem

PR #73 adds the plugin to embed youtube videos and load it when the markdown file is loaded in VuePress. Files like the /using-wasabi/InstallPackage.md or the /FAQ/FAQ-usingwasabi.md have many videos embedded. When loading them either locally or over website, it eats all the RAM of my virtual machine, and it completely crashes. When I remove all the embedded videos and rebuild, everything works fine.

Solution

As discussed with @dennisreimann in PM, it might be possible to only pre-load the thumbnail, and load the full embedded video only when it is clicked.

Out-of-the-box, VuePress provides a search box that is looking through only the headers of all the markdown files. As far as I understand, there is an opt-in extension to allow the search for the text in the files.

I think we should activate this, but it might lead to a cluttered search experience.

There is an official plugin to provide a reference about the last time the markdown file was updated.
I think this is useful for Wasabi Doc because this is an open source archive of knowledge with several contributors, and it might be nice to see that it is growing and maintained.

I suggest we implement this, what do you think?

#46 #48 are also plugin, so implementation might be batched.

Is there a way to add a drop down text box?

This might be useful for the FAQ. All questions are displayed in a single line, each has a drop down arrow, and when clicked it reveals the answer to the question. Somewhat similar to how the new wasabiwallet.io does the FAQ. This would make the [[toc]] obsolete.