To provide guidelines on how to contribute to the Engine Developer Guide. RFC - Engine Developer Guide introduced the Engine Developer Guide, located in the developer branch of o3de.org repo. This guide is "written by engineers, for engineers", as opposed to the other user-facing O3DE Documentation guides (e.g. Getting Started, User Guide, Tools UI).
Guidelines to deliver may include the following topics:
A topic on this specific developer guide, stating its purpose.
Runbook describing the PR workflow and reviewer roles for this guide (which differs slightly from other guides).
Guidelines and examples of recommended use of the Mermaid diagramming tool to create common architectural diagrams.
Limitations
Adding new content to the Engine Developer Guide is out-of-scope for this roadmap item. However, we are tracking issues regarding transferring docs to the Engine Developer Guide. (See Related Links below.)
What is the relevance of this feature?
Having guidelines to reference will be essential for engineers to publish developer documentation about their features.
### Tasks
- [ ] _GitHub issue 1 link_
- [ ] _GitHub issue 2 link and so on._
Summary
To provide guidelines on how to contribute to the Engine Developer Guide. RFC - Engine Developer Guide introduced the Engine Developer Guide, located in the
developerbranch ofo3de.orgrepo. This guide is "written by engineers, for engineers", as opposed to the other user-facing O3DE Documentation guides (e.g. Getting Started, User Guide, Tools UI).Guidelines to deliver may include the following topics:
Limitations
What is the relevance of this feature?
Having guidelines to reference will be essential for engineers to publish developer documentation about their features.
Related Links
Learn more about O3DE roadmaps.