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: restructuring/improvements #2990

Open
13 of 63 tasks
bochinchero opened this issue Sep 23, 2024 · 0 comments
Open
13 of 63 tasks

docs: restructuring/improvements #2990

bochinchero opened this issue Sep 23, 2024 · 0 comments

Comments

@bochinchero
Copy link

bochinchero commented Sep 23, 2024

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
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

No branches or pull requests

1 participant