docs: document sozo bindgen

[MartianGreed]

Closes #

Introduced changes

Add documentation for sozo build command to generate typescript bindings

Checklist

• Updated relevant documentation

Summary by CodeRabbit

• New Features

  • Added a new example reference for "Vanilla-phaser" to provide users with additional context on using Dojo in a vanilla JavaScript environment.

• Documentation

  • Improved clarity and readability of the readme.md with minor formatting adjustments.

[coderabbitai]

Walkthrough

The recent changes enhance the readme.md documentation by adding a new example project, "Vanilla-phaser," showcasing Dojo's capabilities in a vanilla JavaScript context. This addition improves the resourcefulness of the documentation for users while also streamlining the formatting for better readability. Overall, the updates focus on providing clearer, more comprehensive guidance without altering the codebase's functionality.

Changes

Files	Change Summary
readme.md	Added "Vanilla-phaser" example to the examples section; removed unnecessary spaces before section headers for improved formatting.

Poem

In the meadow, code does gleam,
A "Vanilla-phaser" adds to the dream.
With each new line, our docs expand,
Clarity shines, just as planned!
🐇✨ Hop with joy, dear coder friends,
For every update, our journey extends!

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5f81899 and bf4f1de.

Files selected for processing (1)

• readme.md (4 hunks)

Additional context used

Markdownlint

readme.md

42-42: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time

(MD001, heading-increment)

Additional comments not posted (2)

readme.md (2)

32-32: Addition of a new example project is approved.

The new example project "Vanilla-phaser" enhances the documentation by providing users with another example project that demonstrates the capabilities of Dojo in a vanilla JavaScript context.

---

96-97: Addition of TypeScript bindings generation command is approved.

The command for generating TypeScript bindings using sozo build provides clear instructions for users.

[coderabbitai]

Adjust the heading level.

The heading level should be adjusted from h4 to h3 to maintain proper document structure.

- #### Building Packages
+ ### Building Packages

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	#### Building Packages
	### Building Packages

Tools

Markdownlint

42-42: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time

(MD001, heading-increment)