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.

Sign up for GitHub

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

Jump to bottom

Only display exported objects in JS SDK Reference #173

Closed
hackerwins opened this issue Mar 28, 2021 · 0 comments · Fixed by #176
Closed

Only display exported objects in JS SDK Reference #173

hackerwins opened this issue Mar 28, 2021 · 0 comments · Fixed by #176
Assignees
@mojosoeun
Labels
documentation 📔 Improvements or additions to documentation enhancement 🌟 New feature or request

Comments

@hackerwins
Copy link
Member

Description:

We published JS SDK Reference on the web at #163. However, the Reference document exposes unexported objects that can not be accessed by the user.

We need to only display exported objects that are exposed to the user.

In Firebase JS SDK, the type definition file exposed to users is separately managed and Reference Documentation is created through this file.
https://github.com/firebase/firebase-js-sdk/blob/0dfef5dd58f961208e29e249f5e8f5a3e2908c88/CONTRIBUTING.md#-updating-documentation

Why:

It is confusing to the user when unexported objects that are not available are displayed together.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mojosoeun mojosoeun

Labels
documentation 📔 Improvements or additions to documentation enhancement 🌟 New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Only display exported objects in JS SDK Reference with api-extractor yorkie-team/yorkie-js-sdk
2 participants
@hackerwins @mojosoeun