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

Organize tree of topics in the documentation #1614

Open
2 tasks
kring opened this issue Feb 14, 2025 · 0 comments
Open
2 tasks

Organize tree of topics in the documentation #1614

kring opened this issue Feb 14, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@kring
Copy link
Member

kring commented Feb 14, 2025

I suggest (though I'm not sure this is just right yet...):

  • Cesium for Unreal
    • Change Log
    • User Guide - Add a link here to the tutorials on the main web site.
      • Cesium for Unreal v2.0 Upgrade Guide
      • Using Pre-Release Packages
    • Contribution Guide - rename to "Contributing"
      • Code of Conduct
    • Developer Resources - rename to "Contributors' Guide" - perhaps add an intro paragraph about these being resources for people that are modifying Cesium for Unreal itself, rather than people that are using it.
      • Developer Setup
        • Developer Setup for Windows
        • Developer Setup for macOS
        • Developer Setup for Linux
      • Cesium for Unreal Style Guide - rename to "Style Guide"
      • API Design Guide - rename to "API Design"
      • Performance Profiling
      • Releasing a new version of Cesium for Unreal
      • 3D Tiles in Unreal Engine
      • Packaging - delete this, it is too outdated to be useful. The GH Actions scripts are the authority for packaging.
      • Reference Frames - This is pretty outdated, too. It would be good to have something like this, but I think it's just misleading in its current form.

Some other small things to improve in the Cesium for Unreal docs:

  • The Developer Setup page has a broken [TOC] and broken \subpage links to the platform-specific instructions.
  • Is it possible to make the tree on the left expand the selected topic? If so, I think we could eliminate the [TOC] on every page, because it would be mostly redundant.
@kring kring added the documentation Improvements or additions to documentation label Feb 14, 2025
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

1 participant