Skip to content

[ISSUE][DOCS] Components and EBuses page: Restructure #2712

@mythrz

Description

@mythrz

Describe the issue

It does not have a hand-hold explanation that covers everything the dev needs to do. It covers only some of the necessary points, but there are too many gaps to cover.

  • no mention of where to create the classes
  • no mention of the #includes
  • no mention of the cmake changes in case you create a new class
  • no mention on how to call/use/execute the ebus on the component that "triggers"/"requests" the information
  • use typedef instead of using (modern cpp)

Impacted page(s)

https://www.docs.o3de.org/docs/user-guide/programming/components/ebus-integration/

Expected experience

Any senior or junior dev, any student that is starting is degree or college student, can follow the tutorial and finish it. Hand-hold examples or "hello world" examples are a must.


Preliminary drafts:

PR, coming soon:

  • TODO

Parent is:

Metadata

Metadata

Assignees

No one assigned

    Labels

    help-wantedIssue that needs help from a contributor. Must meet help wanted guidelines.kind/content-architectureCategorizes issue as PR as related to the presented structure of documentation.size/XXLDenotes a PR that changes 1000+ lines ignoring generated files.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions