You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Documentation is currently spread across the readmes, docs/wiki and specs in the repo. For new users, particularly those who are less technical, it may be a bit difficultt to locate certain bits of key information.
I'm creating this issue to propose and discuss restructuring the docs/wiki to make documentation easier to navigate and follow. Once the overall structure/direction is kind of settled, I'd like to turn this into a task list so it can be worked through and track progress.
IMHO the structure/format used by dcrdocs to cover Decred and Decrediton is a pretty good place to start - below is a first pass on how I think something similar would look like for dcrdex:
EDIT: Left this for a few weeks since I know folks are quite busy, I'm assuming the proposed structure is good for a first pass and have started a draft PR that will probably cover a good portion of this work, updating the below to a task list.
Introduction
What is Bison Wallet?
What is DCRDEX?
Atomic Swaps - might be better located elsewhere.
Fees - might be better located elsewhere.
Fidelity bonds - might be better located elsewhere.
Tatanka Mesh
Bison Wallet Setup Guide
Download and Install
Setup Bison Wallet
Restore Existing Seed
Quick Configuration
Backup Application Seed
Wallet Synchronization
Creating an account on a DEX Server
External Wallets - might be better located elsewhere.
Using Bison Wallet
Wallets
Receive
Send
Rescanning
Using Custom RPC Providers
Network Specific Features
Decred
Privacy
Staking
Governance
Markets
Placing an Order
Order Types
Reputation
Trading Tiers
Market Parameters (Epoch, Lot Size, Parcel Size, etc.)
Order History
Market Making
Basic Market Maker
Market Maker + Arbitrage
Basic Arbitrage
Configure CEX API Access
Binance / Binance US
Settings
Server Account Management
Adding a DCRDEX server
Changing Tiers
Penalty Management
Exporting / Importing Accounts
Troubleshooting
Advanced
CLI Usage (bwctl)
Client Control API
Building from Source
Docker
Enabling External Access
DCRDEX Server Installation/Config
Development
Contributor Guide
Integrating New Assets
DCRDEX Specification
Simnet Testing
Testnet Testing
Test App Server
Getting Started with Fuzzing
Localization and Translation
The text was updated successfully, but these errors were encountered:
Documentation is currently spread across the readmes, docs/wiki and specs in the repo. For new users, particularly those who are less technical, it may be a bit difficultt to locate certain bits of key information.
I'm creating this issue to propose and discuss restructuring the docs/wiki to make documentation easier to navigate and follow. Once the overall structure/direction is kind of settled, I'd like to turn this into a task list so it can be worked through and track progress.
IMHO the structure/format used by dcrdocs to cover Decred and Decrediton is a pretty good place to start - below is a first pass on how I think something similar would look like for dcrdex:
EDIT: Left this for a few weeks since I know folks are quite busy, I'm assuming the proposed structure is good for a first pass and have started a draft PR that will probably cover a good portion of this work, updating the below to a task list.
The text was updated successfully, but these errors were encountered: