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
78 of 88 tasks
bochinchero opened this issue Sep 23, 2024 · 1 comment
Open
78 of 88 tasks

docs: restructuring/improvements #2990

bochinchero opened this issue Sep 23, 2024 · 1 comment

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.

  • 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
    • Market Making
      • Basic Market Maker
      • Market Maker + Arbitrage
      • Basic Arbitrage
      • Configure CEX API Access
        • Binance / Binance US
    • 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
    • Advanced
      • CLI Usage (bwctl)
      • Client Control API
      • 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
    • Wiki Contribution Guide
@bochinchero
Copy link
Author

After testing pushing my changes to a wiki (see the wiki on my forked repo) I decided to try making smaller pages, since one long page is very difficult to navigate - have also updated to use a custom sidebar.

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