[bisq-network/support] Decide on scope and style of use case articles (#352)

Bayer notifications at github.com
Mon Mar 23 22:59:34 UTC 2020


@kemccall - I appreciate the feedback on #1, i am not a professional writer.

 The modifications that you've made to it are very straight to the point and removes anything considered 'off' topic. I took a look at the comments and it's clear that I mentioned certain things which did not include any further explanation. Limiting the info provided is key. Overall it gives me a better sense of what we're trying to accomplish here.

>The mechanics of how we do this I think we both need to decide upon. But before we go there, let's look at https://bisq.wiki/Delete_and_resync_SPV_file. It's a different animal. It is both Concept (the first 4 paragraphs) and Reference (most of the remainder). You're also exactly right in that it's verbose with a lot of "fluff" (perhaps unrelated info).

I assume you meant page #2 - https://bisq.wiki/Payment_methods. Considering the changes you made to the previous page, I'd remove the intro and make this page purely a reference. 

#3, I agree, too much explanation of what coloured bitcoin is, this concept, should be explained elsewhere. The page should be a reference page on trading fees.

>IMO the Help! I Can't Access the Bisq Settings Screen is a separate use-case.

Agreed, we can link to it at the end of #1. 

>Also, I think that the style for buttons needs to be more distinct and different than code but I'm not sure what at this time.

You mean instead of bolding the text?

>@Bayernatoor Looking at it now in hindsight I'm wondering if the title might be better as "Wallet does not display correct balance". The title now is describing the solution to a problem. People will search for their problem, they won't search for a solution that they don't know. Unless there's some other context for this that I'm unaware of.

The reason this title was selected is that this is often the first solution to most problems encountered with Bisq. Kind of a, let's try this first then investigate further if that doesn't solve it. So perhaps we change the title and as we create more 'problem wiki pages' we link to it as step 1? Or we keep it as is and use it as an across the board solution, may need a new title anyway.

>@Bayernatoor Just now discovered a good reason to NOT use inline commenting when communicating changes - while the comments do not appear in the use case, they DO appear in the search results! Ugh.

Aha, yeah we can discuss it here, seems to work well. Especially if we make individual issues for each page. @wiz created this project board for that purpose. https://github.com/bisq-network/wiki/projects/1



 




-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/bisq-network/support/issues/352#issuecomment-602902618
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.bisq.network/pipermail/bisq-github/attachments/20200323/5eea44c5/attachment-0001.html>


More information about the bisq-github mailing list