o3de.org [ISSUE][DOCS] Component Reference documentation page component categories and components do not match how they are listed in the Editor

[ISSUE][DOCS] Component Reference documentation page component categories and components do not match how they are listed in the Editor

Open LB-ArturZieba opened this issue 1 year ago • 1 comments

Describe the issue

Component Reference documentation page (https://docs.o3de.org/docs/user-guide/components/reference/) component categories and components do not match how they are listed in the Add Component dropdown menu in the Editor.

List of all categories in order as they appear in Editor, available on a project with all Gems included (except OpenXR Vulkan and XR due to https://github.com/o3de/o3de/issues/16169) as of the https://github.com/o3de/o3de/commit/26e68948b32e38f97231274acf90e461b4236f13 commit:

Entity components:

Animation
Audio
Camera
Debugging
Editor
Gameplay
Gradient Modifiers
Gradients
Graphics
- Environment
- Lighting
- Mesh
- Occlusion
- Other
- PostFX
Input
Miscellaneous
Multiplayer
PhysX
Scripting
Shape
Surface Data
Terrain
Test
UI
Vegetation
Vegetation Filters
Vegetation Modifiers

Level components:

Editor
Graphics
- Debugging
- Lighting
- PostFX
Multiplayer
Scripting
Terrain
Test
Vegetation

Following issues were found with the listing on the https://docs.o3de.org/docs/user-guide/components/reference/ page:

Atom Renderer category does not exist anymore, currently in Editor it's listed as Graphics with multiple subcategories (Environment, Lighting, Mesh, Occlusion, Other, PostFX).
Debugging category along with DebugDraw Line, DebugDraw Obb, DebugDraw Ray, DebugDraw Sphere and DebugDraw Text components are missing from the page, due to https://github.com/o3de/o3de.org/issues/1655.
Sky Atmosphere entity component documentation page is missing due to https://github.com/o3de/o3de.org/issues/2218. Currently can be found in the Graphics > Environment category.
Atom Hair entity component documentation page is missing due to https://github.com/o3de/o3de.org/issues/2451. Currently can be found in the Graphics > Mesh category.
HDR Color Grading entity component documentation page is missing and already exists: https://www.docs.o3de.org/docs/user-guide/components/reference/atom/hdr-color-grading/. Currently can be found in the Graphics > PostFX category.
Input category along with Input Context component is missing from the page, due to https://github.com/o3de/o3de.org/issues/2452.
Miscellaneous category along with Detour Navigation Component, Recast Navigation Mesh, and Recast Navigation PhysX Provider components are missing from the page, due to https://github.com/o3de/o3de.org/issues/2453. Entity Reference component is present in the current documentation page, but under the deprecated Atom Renderer category.
Gradient Baker entity component documentation page is missing and already exists: https://www.docs.o3de.org/docs/user-guide/components/reference/gradients/gradient-baker/. Currently can be found in the Gradients category.
Multiplayer category has only the Simple Network Player Spawner level component listed, missing entity components are: Local Prediction Player Input, Network Binding, Network Character, Network Debug Player Id, Network Hierarchy Child, Network Hierarchy Root, Network Hit Volumes, Network Rigid Body, and Network Transform due to https://github.com/o3de/o3de.org/issues/1318.
Level components are mixed in with entity components on the current documentation page, for example Debug Rendering component is listed under the Atom Renderer category with other components found only on entities, while currently it can be found only on the level.prefab under the Graphics > Debugging section.
Specular Reflections level component documentation page is missing due to https://github.com/o3de/o3de.org/issues/2454. Currently can be found in the Graphics > Lighting category on the level.prefab.
Vegetation Debugger level component documentation page is missing due to https://github.com/o3de/o3de.org/issues/2455. Currently can be found in the Vegetation category on the level.prefab.
Vegetation System Settings level component documentation page is missing due to https://github.com/o3de/o3de.org/issues/2456. Currently can be found in the Vegetation category on the level.prefab.