Skip to content

📝 [DOCS] Add complete Slot deployment guide #191

@jimenezz22

Description

@jimenezz22

📝 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 login process
    • Include troubleshooting for old credentials
    • Add debug command: rm ~/Library/Application\ Support/slot/credentials.json
  • 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
  • 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
  • Build & Migration

    • Document sozo build process
    • Explain sozo migrate command
    • Show expected success output with WORLD_ADDRESS
  • Logging & Monitoring

    • Document slot deployments logs DEPLOYMENT_NAME katana -f
    • Explain how to stream logs in separate terminal

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
  • Torii Monitoring

    • Log streaming: slot deployments logs DEPLOYMENT_NAME torii -f
    • How to verify indexer is working correctly

📋 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:

  1. Authenticate with Slot service
  2. Deploy Katana instance successfully
  3. Configure and migrate their Dojo project
  4. Deploy Torii indexer for their world
  5. 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

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions