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

New API docs - too verbose in many cases. #6

Open
Maksims opened this issue Jan 24, 2024 · 0 comments
Open

New API docs - too verbose in many cases. #6

Maksims opened this issue Jan 24, 2024 · 0 comments

Comments

@Maksims
Copy link

Maksims commented Jan 24, 2024

When the eyes are searching through content, it is best to reduce repetition or information duplication.
Currently all properties, methods, etc are duplicated in docs:

image

It also suffers in some places from non-distinct separation.

Remove duplication and provide more accent to meaningful information:

image

@willeastcott willeastcott transferred this issue from playcanvas/developer.playcanvas.com Jan 24, 2024
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

No branches or pull requests

1 participant