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

Differentiate workspace APIs in ref docs #10883

Merged
merged 1 commit into from
Nov 2, 2022
Merged

Conversation

ggetz
Copy link
Contributor

@ggetz ggetz commented Nov 1, 2022

As a follow up from #10824, this updates the doc generation process such that the list of classes is broken up based on the workspaces.

image

image

image

If we think it's warranted, I can also add a tag to to individual item pages. But it might be enough to list the path.

@ggetz ggetz requested a review from sanjeetsuhag November 1, 2022 20:14
@cesium-concierge
Copy link

Thanks for the pull request @ggetz!

  • ✔️ Signed CLA found.
  • CHANGES.md was not updated.
    • If this change updates the public API in any way, please add a bullet point to CHANGES.md.
  • ❔ Unit tests were not updated.
    • Make sure you've updated tests to reflect your changes, added tests for any new code, and ran the code coverage tool.

Reviewers, don't forget to make sure that:

  • Cesium Viewer works.
  • Works in 2D/CV.

Copy link
Contributor

@sanjeetsuhag sanjeetsuhag left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great @ggetz! I think eventually we will want to include a more visible indicator of which package a class belongs to when you open its page, but that can probably wait till when we have more packages. I think this is a good start to organizing our docs.

@sanjeetsuhag sanjeetsuhag merged commit 60ab350 into main Nov 2, 2022
@sanjeetsuhag sanjeetsuhag deleted the workspaces-docs branch November 2, 2022 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants