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

docs: wiki restructuring #3026

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

bochinchero
Copy link

@bochinchero bochinchero commented Oct 16, 2024

addresses #2990

This PR covers the following sections:

  • Home
    • What is Bison Wallet?
    • What is DCRDEX?
    • Tatanka Mesh
    • Project History
  • Getting Started
    • Download and Install
    • Quick Configuration
    • Creating an DCRDEX server account
  • Using Bison Wallet
    • Header
      • Notifications Panel
        • Notifications
        • Recent Activity
      • Language Switching
      • Settings Panel
    • Settings Panel
    • Wallet View
      • Asset Selection
        • Creating a new wallet
          • Native Wallet
          • External Wallet
      • Wallet Details
      • Receive
      • Send
      • Wallet Settings
      • Fee Status
      • Transaction History
      • Asset Markets
      • Recent Activity
      • Asset Specific Features
        • Decred
          • Privacy
          • Staking
          • Voting Preferences
      • RPC Providers for EVM-Compatible networks
    • Trade View
      • Markets
      • Order Book
      • Candle & Depth Charts
      • Order Panel
        • Submit Order
        • Trading Tier
        • Reputation
        • Your Orders
        • Recent Matches
    • Order Management
      • Order Types
      • Placing an Order
        • Fee Details
        • Lot Size
      • Trade Execution
      • Order History
      • Order Details
    • Managing your DCRDEX Accounts
      • Changing Trading Tier
      • Reputation Score
      • Adding a new DCRDEX Server
      • Export DCRDEX Account
      • Import DCRDEX Account
    • Troubleshooting
      • Location of Applicaton and Log Files
      • Native Wallets
        • Rescnaning
        • Recovery
        • Forced Rescan
        • Full Reinitialize
  • Development & Contributing
    • Contributor Guide
    • Client Control API
    • Integrating New Assets
    • DCRDEX Specification
    • Simnet Testing
    • Testnet Testing
    • Test App Server
    • Getting Started with Fuzzing
    • Localization and Translation
    • Wiki Contribution Guide

@bochinchero bochinchero force-pushed the docs-restructure branch 2 times, most recently from 0bc9ec3 to 0309e10 Compare October 22, 2024 16:34
@bochinchero bochinchero force-pushed the docs-restructure branch 4 times, most recently from 2b1ea69 to 4145780 Compare November 1, 2024 14:58
@bochinchero bochinchero marked this pull request as ready for review November 14, 2024 11:39
docs/wiki/Home.md Outdated Show resolved Hide resolved
The first line indicates the current language, while the second has the different options for
selection.

<img src="./images/using-bison-wallet/header-language.png" width="300" alt="">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We now have icons for language

image

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

didn't see this on the tagged v1.0.2

image

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, all my pics are from current master, sorry.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think commit a700197c90d42fdf2ef2f983ddec1a162824af7b is where the text was changed for national flag images - in client/webserver/site/src/js/app.ts, I could be wrong.

image

const languageData: Record<string, LangData> = {
  'en-US': {
    name: 'English',
    flag: '🇺🇸' // Not 🇬🇧. MURICA!
  },
  .
  .

@dev-warrior777
Copy link
Contributor

Looks great! .. really clean.

Copy link
Member

@JoeGruffins JoeGruffins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

partial review

docs/wiki/Creating-a-DCRDEX-Server-Account.md Outdated Show resolved Hide resolved
docs/wiki/Creating-a-DCRDEX-Server-Account.md Outdated Show resolved Hide resolved
docs/wiki/Creating-a-DCRDEX-Server-Account.md Outdated Show resolved Hide resolved
Comment on lines +123 to +126
It is recommended to export your DCRDEX account information whenever they are created since your bonds
are not automatically restored from just the application seed, refer to the
[Export DCRDEX Account](Managing-your-DCRDEX-Accounts#export-dcrdex-account) section of this wiki for
more information.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some bonds are restored automatically now #2613 but maybe no need to say that...

The seed actually has all the private data needed to restore accounts and bonds, the problem is that we don't know where to look currently. A version 2 bond could fix this.

docs/wiki/Development-and-Contributing.md Outdated Show resolved Hide resolved
docs/wiki/Home.md Outdated Show resolved Hide resolved
docs/wiki/Home.md Outdated Show resolved Hide resolved
Comment on lines +4 to +16
Adding support for an asset is accomplished by writing a
[Go](https://golang.org/) package with types that implement a particular set of
interfaces, defined [here](https://github.com/decred/dcrdex/blob/master/server/asset/common.go)
and [here](https://github.com/decred/dcrdex/blob/master/server/asset/driver.go).
There are then two ways to import the asset backend into the server software.

1. The package is compiled with -``buildmode=plugin`` and imported at runtime by specifying
the plugin in the server configuration.
2. The backend is added to the dcrdex repository, and imported directly at compile time.

With the exception of a small handful of assets which will be implemented during
initial phases of DEX development, it is expected that development communities
will release their own appropriately vetted plugins.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder how accurate this is. I have never tried buildmode=plugin This also doesn't say anything about client. And the development communities haven't shown their faces yet...

docs/wiki/Managing-your-DCRDEX-Accounts.md Outdated Show resolved Hide resolved
docs/wiki/Managing-your-DCRDEX-Accounts.md Outdated Show resolved Hide resolved
Copy link
Member

@JoeGruffins JoeGruffins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice. Thanks for this!

docs/wiki/Managing-your-DCRDEX-Accounts.md Outdated Show resolved Hide resolved
Comment on lines +101 to +102
While Bison Wallet's native wallets can be restored from the application's seed,
the DCRDEX server accounts bonds need to be backed up separately. This is done by
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we only return current and past bonds, so every time a new bond is created one would need to do this.. Maybe no need to say anything though. Any current bonds reported by the server are restored without this info and just seed.

docs/wiki/Order-Management.md Outdated Show resolved Hide resolved
docs/wiki/Order-Management.md Outdated Show resolved Hide resolved
docs/wiki/Order-Management.md Outdated Show resolved Hide resolved
docs/wiki/Wallet.md Outdated Show resolved Hide resolved
docs/wiki/Wallet.md Outdated Show resolved Hide resolved
## Privacy

When privacy is enabled, all of your funds are sent through Decred's address history obfuscation service, using a
protocol called StakeShuffle. StakeShuffle generates outputs that cannot be definitively linked to previous on-chain
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

idk did we coin StakeShuffle? I thought CoinShuffle++

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see #3042

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ohhh, we did coin it. Thanks.

docs/wiki/Wallet.md Outdated Show resolved Hide resolved
docs/wiki/Wallet.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants