CesiumGS
Add developer documentation
Hi, may I ask why I can't find a developer manual about Cesium Native? It's hard to fully understand it only from the source code.
The individual classes in cesium-native are reasonably well documented. I studied cesium-unreal hard in order to write vsgCs.
Since we have #832 to actually publish our Doxygen-generated documentation, I'd like to repurpose this issue for the actual organization.
Our Doxygen docs will be on the website regardless, but it will take more resources to actually help users understand what's going on. For instance, see #982 , #981 , #980.
We should figure out the best place for these resources to live, and where they would be most easily accessed / used. Should they:
- Be markdown files stored in the cesium-native repo?
- Live on the website somewhere?
- Both?
It could even be worth taking advantage of our learning platform at https://cesium.com/learn/ to create an entirely separate category for Cesium Native. The "tutorials" could walk through how a simple integration with Cesium Native could look like, and host other written documentation for concepts that users would need to know.
I'd like to advocate for keeping the cesium-native docs in markdown and in the same repo as the code. Because:
- cesium-native is inherently a developer product. The polish of the web site isn't as essential.
- Managing content in the web site CMS adds a ton of friction for us.
- Keeping docs in the repo makes versioning basically free. On the web site, it's a nightmare.
Closing this issue. We have decided to keep put these docs in doxygen, and these docs will be published every release to https://cesium.com/learn/cesium-native/ref-doc/.