Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding new Q&A to the FAQ (documentation) #1717

Merged
merged 5 commits into from Jul 7, 2019

Conversation

@raindogdance
Copy link
Contributor

commented Jul 3, 2019

Added some Q&A on the general beginner level.

I’m a little worried that I am breaking the existing structure of the FAQ (“Will my coins be fully private after mixing with Wasabi?” might belong into the “post-mix” section, f.ex), but it is made up by the significance of those questions to a beginner who just heard about Wasabi/coinjoin, that’s why I think it’s good to have them on top. If the “pre-install” section is wrong for those, perhaps we could create a new section called “general” or something like that?

raindogdance and others added 5 commits Jul 3, 2019
@nopara73

This comment has been minimized.

Copy link
Collaborator

commented Jul 7, 2019

Structure is ok, I think. I've done a couple of nitpicking, feel free to review and ask some questions if you don't understand why I did something.

@nopara73 nopara73 merged commit eceee4e into zkSNACKs:master Jul 7, 2019

1 of 4 checks passed

Wasabi.Linux in progress
Details
Wasabi.Osx in progress
Details
Wasabi.Windows in progress
Details
CodeFactor No issues found.
Details
@raindogdance

This comment has been minimized.

Copy link
Contributor Author

commented Jul 8, 2019

Good nitpicking! 👍

Two nitpicks from my side:

Both the sending address, the coinjoin input and the receiving address, the coinjoin output are controlled by your own private keys.

Due to the current structure of the sentence, an user unfamiliar with the technicalities might be confused which of the terms belong together and that "coinjoin input" is just another name for "sending address" in this context (a comma might mean that it's just a separate term being listed here). I think writing it like this makes it a little less ambiguous:

Both the sending address (the coinjoin input) and the receiving address (the coinjoin output) are controlled by your own private keys.`

In this scenario, Wasabi will barely make any improvement to your privacy, it still have a protective effect against unsophisticated observers.

Here it either needs to be "it still HAS" or "it still WILL have". Also this part of the sentence needs to be prefaced by "although", imo. I think this is better:

In this scenario, Wasabi will barely make any improvement to your privacy, although it still will have a protective effect against unsophisticated observers.

Hope that makes sense :)

Not sure what the best practice for GitHub here is (am noob, sorry), do I just create a new pull request (if the changes make sense in the first place), or can it be changed within this current PR? Or otherwise please feel free to just change it yourself if that's easier :)

@nopara73

This comment has been minimized.

Copy link
Collaborator

commented Jul 8, 2019

ACK for all your suggestions. Just click the edit button on the document when you're on the master branch and make a new PR. This PR cannot be modified anymore, because it's merged.

raindogdance added a commit to raindogdance/WalletWasabi that referenced this pull request Jul 8, 2019
Update FAQ.md
Two minor phrasing amendments, as discussed here: zkSNACKs#1717 (comment)
raindogdance added a commit to raindogdance/WalletWasabi that referenced this pull request Jul 15, 2019
update fork (#3)
* Update WalletWasabi.Documentation/PasswordFinder.md

Co-Authored-By: Max Hillebrand <30683012+MaxHillebrand@users.noreply.github.com>

* Fallback if filedialog fails.

* Remove leftover code

* Fix hang on QR code generation

* Remove output scheduler

* Use c# 7 pattern matching to merge type check and cast

* Moved predicate, removes redundant where call

* Using method groups instead of lamdas

Syntax is more succint and less compile-time overheard by not using lambdas

* Replaced with method group

* Removed redundant catch clause

* Removed redundant tostring call

* Edit HandshakeAsync method

* Add OneDayConfirmationTarget (144) as const

* Fix typos

* Replace 'can not' by cannot for consistency

* Replace doesn't by does not for consistency

* Fix typos

* Replace labelling by labeling

* Replace didn't by did not

* Replace wasn't by was not

* Replace isn't by is not

* Remove unnecessary checks in TrySetWalletStates() method

* Replace aren't by are not & hasn't by has not

* Edit variable & parameter name

* Use nameof instead of hardcoded strings

* Correct variable name

* Correct property & field names

* Correct method, parameter, variable names

* [skip ci] Update the methodology of seeding

* Correct method, parameter, variable names (MemPool to Mempool)

* Implement reduceonions function to the packager

* Make if more efficient

* Improve TestServicesAsync

* Dump client version

* Fix PinPadView Initialization

* Ensure Filter Height integrity

* Downgrade ClientVersion

* fix expander

* hide expander click area.

* fix expander click area so its invisible.

* fix crashing when starting with Lurking Wife Mode enabled.

* unsubscribe isexpanded after first time.

* use take(1) instead of firstasync

* Remove duplicae null check, simplified state check

* Removed unnecessary ternery expression

* validate dust threshold is positive

* validate port is not a reserved port

* Reduced code by using object initializer

* Update WalletWasabi.Documentation/PasswordFinder.md

Co-Authored-By: nopara73 <adam.ficsor73@gmail.com>

* Removed unnecessary ternary expression

* Use is instead of ==

* Correct members' names

* Replace couldn't by could not

* grammatical error fix

* remove old check to see if qr is not already generated.

* Use firstfilter

* CodeFactor

* Fix Send/Address box behavior according to AutoCopy setting

* Improve text

* Fix TotalAmount calculation when tx sent

* Make code more efficient

* Correct members' names

* Remove S_ prefix for const (name violation rule)

* Correct variable names

* temporary preview of 0.8.1 rc.

* update to avalonstudio.shell 0.8.1 and avalonia 0.8.1

* Correct variable names

* Correct variable names

* Order onions with Packager

* Update the onion seed list

* Dump Client Version

* Update website links

* Update versions in guides

* Add detbuildguide to versionupdate notes

* fix build error

* Rename filenames

* Boolean-String converter impl in SettingsView

* Replace MaxClearConverter by BooleanStringConverter

* Replace ShowHideSensitiveConverter  by Bool2Str

* fix up code

* LurkingWifeMode on transaction view page

* Fix message

* Added mode attribute

* Display sensitive data in red color

* Fix typos

* Replace don't by do not

* Prefer expression body for properties

* Remove unused member

* Correct typos

* Use DeepEquals for config file change detection

* Update 20190617ContributionGame.md

* [Refactor] Remove unused code

* Change color to IndianRed

* Remove useless CcjRoundConfig constructor

* Update FAQ.md

Two minor phrasing amendments, as discussed here: zkSNACKs#1717 (comment)

* Simplify member access

* Update and normalize Coding Conventons with uncontroversial guidelines (for pull request reviewing.)

* Update CONTRIBUTING.md

Closes zkSNACKs#1856

* Delete CodingConventions.md

* Remove some unnecessary checks

* CodeMaid

* btcsessions

* Cleanup code according to CodeMaid

* New line before open brace (Remove Java-like brackets)

* Edit new-line-before-open-brace entry in editorconfig (to override CodeMaid configuration)

* Correct typos, capitalization, punctuation

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Amount color changes to Red when no coins are selected

* ordinialignorecase

* Rename TotalAmount to SelectedAmount

* Make SelectedAmount Money

* syntax

* Rename BtcFee to EstimatedBtcFee

* Rename Amount to AmountText

* Use UsdExchangeRate as ToProperty

* Amount color changes to red when no coins are selected

* Replace typewriter apostrophe by typographic apostrophe in PrivacyPolicy document

* bugfix: add missing null check

* Update project description and tags to match GitHub

* Confirmations on confirmed checkmark tooltip

* Remove fee slider when unavailable

* Remove unnecessary checks

* Use method group instead of lambda

* Update CONTRIBUTING.md

* Prefer Oaph Over Properties

* Correct typo

* Fix typos (occured & occurence)

* Correct possible mistakes

* Used Constants.SevenDaysConfirmationTar instead of 1008

* Small changes

* Small typo corrections

* Prefer expression body for operators

* Small correction

* Fix linux dock issue

* Update CONTRIBUTING.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.