Improve EntityView docs

[Indra-db]

Bounty: Improve Documentation Clarity

Objective:
Enhance the project documentation of EntityView so that new users can easily understand and use the API without needing additional external references.

---

Tasks:

• Improve Clarity:

  • Rewrite documentation to clearly explain the purpose and usage of each public function on EntityView.
  • Define technical terms and usage patterns as needed.
  • Use concise, unambiguous language to ensure clarity for newcomers.

• Add Examples:

  • Provide clear, practical examples for every public function missing one.
  • Use examples and test cases from EntityView as models, inspiration.

• Remove C++ API References:

  • Eliminate all references to the C++ API to avoid confusion for users expecting a Rust-centric documentation.

• Ensure Doc Tests Pass:

  • Update and verify that all documentation tests (doc tests) run successfully after changes.

• Reference Implementation:

  • For guidance on the expected quality and style, review commit 52b5fa8 (please open the diff to inspect the work).

---

Acceptance Criteria:

• The documentation is clear, concise, and easily understandable by new users.
• Every public function includes at least one illustrative example.
• All references to the C++ API have been removed.
• All documentation tests pass without errors.

---

End Condition:
When all tasks have been completed and verified according to the acceptance criteria, the bounty will be considered complete. This won't be overly strict, I just expect good quality ;)

[Indra-db]

@addbounty $50

[addbounty]

Make a Draft PR early so others can see you are working on it! To automatically create one:

# Using npx (installed if you have NodeJS/npm)
npx bountybot solve Indra-db/Flecs-Rust#233

Join Our Discord to connect with other bounty hunters and get help.

When merged, you will receive the bounty!

[Lowsecs]

I have a proposal for review: https://github.com/Indra-db/Flecs-Rust/pull/247