Skip to content

Conversation

@ayushap18
Copy link

Summary

Added comprehensive educational documentation for Fleet SDK beginners.

New Documentation Files

1. installation.md (~350 lines)

  • Complete setup guide for all environments
  • Package installation for all @fleet-sdk modules
  • TypeScript configuration
  • Troubleshooting section

2. core-concepts.md (~500 lines)

  • UTXO model explained
  • Box structure and registers
  • ErgoTree basics
  • Transaction anatomy

3. tutorial.md (~600 lines)

  • "Build Your First dApp" step-by-step guide
  • Address generation
  • Transaction building
  • Token operations
  • Working code examples

4. contract-signing.md (~450 lines)

  • Contract box signing patterns
  • Multi-signature transactions
  • Context variables
  • Security best practices

Sidebar Updated

  • Added new "Getting Started" section
  • Linked all new documentation pages

Related

  • Part of Unstoppable Hackathon 2025 @ LNMIIT
  • Bounty: fleet-sdk/docs/[Educational] Fleet-Tutorial + Bounties

Addresses issues:
- fleet-sdk#3: Installation guide from fresh install to running examples
- fleet-sdk#8: Educational tutorial with complete dApp example
- fleet-sdk#10: Core concepts chapter (UTXO, Boxes, Transactions)
- fleet-sdk#11: Contract signing documentation for non-wallet boxes

New files added:
- docs/installation.md - Complete installation guide
- docs/core-concepts.md - Ergo fundamentals explained
- docs/tutorial.md - Build your first dApp tutorial
- docs/contract-signing.md - Advanced signing patterns

Updated:
- docs/.vitepress/config.ts - Sidebar navigation
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.

1 participant