-
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
We need to create comprehensive documentation for deploying Dojo games using
Slot service, covering both Katana and Torii deployment. This documentation
should follow the official Dojo guide structure.
📚 Context
Currently, the /deployments/slot page exists but lacks detailed content. We
need to document the complete workflow from authentication to Torii indexer
deployment.
✅ Tasks
Backend Deployment Documentation (pages/deployments/slot.md)
-
Authentication Setup
- Document
slot auth loginprocess - Include troubleshooting for old credentials
- Add debug command:
rm ~/Library/Application\ Support/slot/credentials.json
- Document
-
Katana Deployment
- Initialize project:
sozo init dojo-starter && cd dojo-starter - Create deployment:
slot deployments create DEPLOYMENT_NAME katana - Explain RPC endpoint retrieval
- Document Scarb.toml configuration updates for
rpc_url
- Initialize project:
-
Configuration Management
- Show how to update
[tool.dojo.env]with new RPC URL - Document account address and private key configuration from Katana logs
- Note about unique account seeds per Katana slot
- Show how to update
-
Build & Migration
- Document
sozo buildprocess - Explain
sozo migratecommand - Show expected success output with WORLD_ADDRESS
- Document
-
Logging & Monitoring
- Document
slot deployments logs DEPLOYMENT_NAME katana -f - Explain how to stream logs in separate terminal
- Document
Torii Indexer Documentation
-
Torii Deployment for Slot instances
- Full command:
slot deployments create DEPLOYMENT_NAME torii --world YOUR_WORLD_ADDRESS --rpc YOUR_NEW_RPC_URL --start-block 1 - Explain each parameter purpose
- Document GraphQL and gRPC endpoints received after deployment
- Full command:
-
Torii Monitoring
- Log streaming:
slot deployments logs DEPLOYMENT_NAME torii -f - How to verify indexer is working correctly
- Log streaming:
📋 Acceptance Criteria
- Complete step-by-step guide following official documentation structure
- All commands are properly formatted and tested
- Clear explanation of each step's purpose
- Note about using latest dojo version with
dojoup - Proper code blocks with syntax highlighting
- Success messages clearly indicated
🎯 Expected Outcome
Developers should be able to:
- Authenticate with Slot service
- Deploy Katana instance successfully
- Configure and migrate their Dojo project
- Deploy Torii indexer for their world
- Monitor both services through logs
💡 Additional Notes
- Ensure consistency with existing documentation style
- Use same DEPLOYMENT_NAME throughout examples for clarity
- Include congratulations message at successful deployment
📚 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