Skip to content

docs: add comprehensive end-user documentation and guide#232

Open
kovadev17 wants to merge 1 commit intoANAVHEOBA:mainfrom
kovadev17:docs/user-guide
Open

docs: add comprehensive end-user documentation and guide#232
kovadev17 wants to merge 1 commit intoANAVHEOBA:mainfrom
kovadev17:docs/user-guide

Conversation

@kovadev17
Copy link
Copy Markdown

Closes #20

Changes

  • Created docs/USER_GUIDE.md with 2300+ words (exceeds 1500 word requirement)
  • Comprehensive coverage of all required sections:
    1. Introduction (what, how, guarantees, limitations)
    2. Getting Started (wallet setup, funding, accessing dApp)
    3. Making a Deposit (step-by-step with critical backup warnings)
    4. Making a Withdrawal (step-by-step with proof generation)
    5. Note Management (backup practices, recovery impossibility)
    6. Security Best Practices (privacy + fund protection)
    7. Privacy Considerations (anonymity set, timing, amount correlation)
    8. Troubleshooting (common errors and solutions table)
    9. FAQ (10 common questions)
  • Non-technical language throughout
  • Glossary of technical terms
  • Prominent security warnings for note backup
  • Clear acceptance criteria coverage per issue requirements

Closes ANAVHEOBA#20

- Complete USER_GUIDE.md with 2300+ words
- Covers introduction, getting started, deposits, withdrawals
- Note management and security best practices
- Privacy considerations including timing attacks
- Troubleshooting guide and FAQ
- Glossary of technical terms
- Written for non-technical users as required
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.

[BOUNTY] Write End-User Documentation and Guide

1 participant