chanmosq
commented
1 year ago Hello @AMZN-daimini, excited to hear this! This will be very useful for the engine's development.
Based on the target audience for these docs, I think the best place will be the Engine Developer Guide, a new guide that lives on the development branch. (Soon, we'll make this guide accessible from the Docs landing page via the main branch.)
For the contents of the Action Manager developer guide, you can take a look at the Terrain developer guide as an example. (These will be migrated to the Engine Developer Guide.) Your high-level sections might look something like this, with architecture/overview first and reference docs last:
- Architecture (Usually only one page)
- Developing with the Action Manager System (One page with larger subsections, or you can split into multiple pages in a way that makes sense. If multiple pages, I suggest keeping the pages flat and not creating a subdirectory. Unless this is a really big section, I don't think it's necessary.)
- Migrating to the Action Manager System (Usually one page)
- API Reference (One page with larger subsections)
Depending on how complex the Action Manager system is, you may want to separate the architecture topics by each sub-module as well.
For API reference, will the API be generated alongside the other O3DE engine code and these proposed API references further detail how to use the API? If so, you can structure these docs to focus on the functionality, or what you're doing with the API. For example, in the Terrain Developer Guide, there are the sections Using the terrain system and Extending the terrain system.
You can continue to reach sig-docs-community through this RFC or Discord, or message me directly as well! We can continue to plan these docs.
Feature: Action Manager developer documentation
The Action Manager is a new system that replaces the existing architecture(s) used to define menus, toolbars, hotkeys and overall editor actions in O3DE. We want to introduce proper developer documentation to enable existing and new systems, both core to the editor or added via Gems, to adopt the system and thus standardize the user experience across all the different parts of the Editor.
More details about this feature: https://github.com/o3de/sig-content/issues/51 (The RFC goes over some user customization functionality at the end that was not included in the current MVP, but gives a good overview of the scope)
What is the relevance of this feature?
By providing a complete developer documentation, we aim to facilitate adoption which will enhance the extensibility of the Editor overall.
What are the advantages of the feature?
Scope of work
The Action Manager system is also comprised of additional sub-systems that manage Menus, ToolBars and Hotkeys. Documentation should likely include
I am planning to dedicate the time necessary to write down the bulk of this documentation; the support that I would need from sig-docs-community is related to the style and hierarchy of the pages/topics to conform with the rest of the docs.