-
Notifications
You must be signed in to change notification settings - Fork 50
Labels
Maintainer: jimenezz22documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomersonlydust-waveContribute to awesome OSS repos during OnlyDust's open source weekContribute to awesome OSS repos during OnlyDust's open source week
Description
📝 Description
Create a simplified overview documentation explaining Torii indexer and its
role in the Dojo ecosystem. Keep it concise and practical.
📚 Context
New developers need a quick understanding of what Torii is and why they need
it, without overwhelming technical details.
✅ Tasks
Torii Overview Documentation (pages/deployments/torii/overview.md)
-
What is Torii?
- Official indexing engine for Dojo worlds
- Automatically syncs blockchain state to a database
- Provides APIs to query game data efficiently
- Built in Rust for performance
- Comes pre-installed with Dojo toolchain
-
Why use Torii?
- Direct blockchain queries are slow and expensive
- Torii indexes your game state for instant access
- Real-time updates via subscriptions
- Multiple query options (GraphQL, gRPC, SQL)
-
How it works (simplified)
- Monitors your deployed World contract
- Captures all game state changes
- Stores data in local database
- Provides APIs for your client to query
-
API Interfaces
- GraphQL: Flexible queries with subscriptions
- Endpoint:
http://localhost:8080/graphql
- Endpoint:
- gRPC: High-performance binary protocol
- Endpoint:
http://localhost:8080
- Endpoint:
- GraphQL: Flexible queries with subscriptions
-
When to use Torii
- Fetching player statistics
- Building leaderboards
- Real-time game state updates
- Historical game data analysis
-
Installation Note
- Torii is included by default when you install Dojo
- No separate installation needed
📋 Acceptance Criteria
- Clear, concise explanation (no overwhelming details)
- Practical examples of use cases
- Mention that Torii comes with Dojo
- Links to deployment and integration guides
🎯 Expected Outcome
A developer should understand in 2-3 minutes:
- What Torii does
- Why they need it
- That it's already installed with Dojo
- What APIs it provides
💡 Additional Notes
- Keep technical jargon to minimum
- Focus on practical benefits
- Avoid deep architecture details
- Use simple analogies if helpful
📚 References
Contribution Guidelines
- Please ensure you read and follow the contribution guidelines in the project's README file
Metadata
Metadata
Assignees
Labels
Maintainer: jimenezz22documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomersonlydust-waveContribute to awesome OSS repos during OnlyDust's open source weekContribute to awesome OSS repos during OnlyDust's open source week