You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
There have been a couple of discussions about whether or not we should be moving in a direction of "self-hosted" Gem documentation. There's some technical considerations for this both on the O3DE side (like support for targeting single Gems to build, test, and generate API docs for) and the website side (what does publishing "self-hosted" Gem docs look like?)
In general, here is what I mean by "self-hosted":
Each Gem contains its own README.md, which would be a high-level overview of features, configuration information, etc.
Each Gem provides a full reference for its Component, Script Canvas, and Lua bindings.
We could add that all Gem documentation should be hosted in a Gem, but this would almost immediately introduce all kinds of technical or structural problems for core Gems such as, say, Animation or PhysX, which need to have their full documentation as part of the user guide (these are core elements for making a game or simulation.)
Doesn't mean this is the right solution, but it's been something discussed multiple times in SIG channels and internally at AWS, so it would be good to have an open discussion leading to an RFC (if we think it's a good idea.)
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
There have been a couple of discussions about whether or not we should be moving in a direction of "self-hosted" Gem documentation. There's some technical considerations for this both on the O3DE side (like support for targeting single Gems to build, test, and generate API docs for) and the website side (what does publishing "self-hosted" Gem docs look like?)
In general, here is what I mean by "self-hosted":
We could add that all Gem documentation should be hosted in a Gem, but this would almost immediately introduce all kinds of technical or structural problems for core Gems such as, say, Animation or PhysX, which need to have their full documentation as part of the user guide (these are core elements for making a game or simulation.)
Doesn't mean this is the right solution, but it's been something discussed multiple times in SIG channels and internally at AWS, so it would be good to have an open discussion leading to an RFC (if we think it's a good idea.)
Beta Was this translation helpful? Give feedback.
All reactions