Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Find best method for organizing developer documentation #619

Open
HolenWu opened this issue Apr 12, 2023 · 4 comments
Open

Find best method for organizing developer documentation #619

HolenWu opened this issue Apr 12, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@HolenWu
Copy link

HolenWu commented Apr 12, 2023

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.

@timoore
Copy link
Contributor

timoore commented Apr 12, 2023

The individual classes in cesium-native are reasonably well documented. I studied cesium-unreal hard in order to write vsgCs.

@DengSenHandsome
Copy link

@kring

@kring kring changed the title Questions about the developer manual Add developer documentation May 9, 2023
@kring kring added the documentation Improvements or additions to documentation label May 9, 2023
@j9liu j9liu changed the title Add developer documentation Find best organization for developer documentation Nov 8, 2024
@j9liu j9liu changed the title Find best organization for developer documentation Find best method for organizing developer documentation Nov 8, 2024
@j9liu
Copy link
Contributor

j9liu commented Nov 8, 2024

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.

@kring
Copy link
Member

kring commented Nov 12, 2024

I'd like to advocate for keeping the cesium-native docs in markdown and in the same repo as the code. Because:

  1. cesium-native is inherently a developer product. The polish of the web site isn't as essential.
  2. Managing content in the web site CMS adds a ton of friction for us.
  3. Keeping docs in the repo makes versioning basically free. On the web site, it's a nightmare.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

5 participants