Skip to content

Conversation

@respp
Copy link

@respp respp commented Aug 29, 2025

Pull Request Overview

📝 Summary

This PR adds a comprehensive Torii indexer overview documentation to help new developers understand Torii's role in the Dojo ecosystem. The documentation provides a beginner-friendly introduction that explains what Torii is, why it's needed, and how it works in under 3 minutes of reading time.

Related Issues

Type of Change

Mark with an x all the checkboxes that apply (like [x]).

  • 📝 Documentation (updates to README, docs, or comments)
  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • 👌 Enhancement (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)

🔄 Changes Made

What's Changed

  • Added new documentation file: client-new/pages/deployment/torii/overview.md
  • Updated navigation: Added Torii Indexer subsection to the Deployment section in client-new/src/routes.ts
  • Created comprehensive overview: Beginner-friendly documentation covering Torii's purpose, benefits, and usage

Implementation Details

  • Content Structure: Organized into clear sections (What is Torii, Why Use Torii, How It Works, API Interfaces, Use Cases, Installation)
  • Writing Style: Used simple analogies (search engine, library catalog) to make technical concepts accessible
  • Navigation Integration: Added proper routing and cross-references to existing documentation
  • File Organization: Placed in logical location under deployment/torii/ directory

Technical Notes

  • File Location: client-new/pages/deployment/torii/overview.md
  • Format: Markdown with proper frontmatter (title, description)
  • Length: 60 lines (~300 words, 2-3 minutes reading time)
  • Navigation: Added to routes.ts with proper sidebar structure
  • Links: Includes references to local development guide and official Dojo docs

🔧 Tests Results

Describe the tests you performed to verify your changes.

Test Coverage

  • Unit Tests
  • Integration Tests
  • Manual Testing

Evidence

  • Content Review: Verified all PRD requirements are met
  • Navigation Testing: Confirmed Torii section appears correctly in sidebar
  • Link Validation: Checked all internal and external links are functional
  • Format Verification: Ensured proper Markdown formatting and frontmatter
  • Length Compliance: Confirmed 60 lines meets 2-3 minute reading time requirement

Testing Notes

  • Cross-browser: Navigation structure tested for consistency
  • Mobile-friendly: Content structure verified for mobile readability
  • Accessibility: Proper heading hierarchy and descriptive link text implemented
  • Content Accuracy: All technical information verified against official Dojo documentation

🔜 Next Steps

  • Content Review: Request technical review from Dojo maintainers for accuracy
  • User Feedback: Gather feedback from new developers on clarity and usefulness
  • Integration Testing: Test navigation flow with existing documentation
  • Future Enhancements: Consider adding interactive examples or diagrams if needed
  • Related Documentation: May need to update local.md deployment guide to include Torii setup instructions

respp added 2 commits August 29, 2025 14:57
- Create beginner-friendly overview explaining Torii's role in Dojo
- Include what Torii is, why to use it, and how it works
- Add API interfaces (GraphQL, gRPC) with endpoints
- Provide practical use cases and installation notes
- Keep content concise for 2-3 minute reading time
- Address GitHub issue AkatsukiLabs#193 for Torii overview documentation
- Add Torii Indexer subsection under Deployment navigation
- Include Overview and Client Integration links
- Ensure proper navigation structure for Torii documentation
- Maintain consistent navigation patterns with existing sections
Copy link
Contributor

@jimenezz22 jimenezz22 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a url for a torii instance looks like https://api.cartridge.gg/x/YOUR_INSTANCE_NAME/torii

and for graphQL: const TORII_URL = dojoConfig.toriiUrl + "/graphql";

or

https://api.cartridge.gg/x/YOUR_INSTANCE_NAME/torii/graphql

@jimenezz22 jimenezz22 added the Changes Requested PR with changes requested label Sep 7, 2025
@respp respp requested a review from jimenezz22 September 10, 2025 02:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Changes Requested PR with changes requested

Projects

None yet

Development

Successfully merging this pull request may close these issues.

📝 [DOCS] Add Torii indexer overview

2 participants