Skip to content

Conversation

@ryzen-xp
Copy link
Contributor

Pull Request Overview

📝 Summary

Added Models Fundamentals documentation as an entry point for developers learning Dojo models and ECS architecture. The file reorganizes key concepts from models.md into a structured, game-focused learning path.

Related Issues

Type of Change

  • 📝 Documentation
  • 🐛 Bug fix
  • 👌 Enhancement
  • 💥 Breaking change

🔄 Changes Made

  • Added /client/pages/getting-started/basics/models/ModelsFundamentals.md
  • Extracted & reorganized core content from models.md
  • Structured into 5 progressive sections (ECS basics → Model anatomy → Keys → Field types → Custom types)
  • Included gaming-focused examples (Player, Beast, Potion)
  • Added table of contents, cross-references, and next steps

🔧 Tests

  • Manual review of content & examples
  • Verified readability, learning flow, and code validity
  • Confirmed cross-references and gaming terminology

🔜 Next Steps

  • Add advanced models-patterns.md
  • Cross-link fundamentals across docs
  • Gather feedback to refine structure

@jimenezz22 jimenezz22 self-requested a review September 2, 2025 00:24
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.

why did you upload all of these changes? you just need to modify a markdown file

@ryzen-xp
Copy link
Contributor Author

ryzen-xp commented Sep 2, 2025

@jimenezz22 Hi, I upload this to pass Github Ci it failed due to not fmt code . After it looks good

@ryzen-xp ryzen-xp requested a review from jimenezz22 September 2, 2025 04:37
@jimenezz22
Copy link
Contributor

@jimenezz22 Hi, I upload this to pass Github Ci it failed due to not fmt code . After it looks good

GitHub Actions are for contracts issues. But I think it's ok

@jimenezz22 jimenezz22 added the Approved PR ready to merge label Sep 3, 2025
@coxmars coxmars merged commit 6a3ea3c into AkatsukiLabs:main Sep 3, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Approved PR ready to merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

📝 [DOCS-REFAC] Create Models Fundamentals Documentation File

3 participants