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

Make JS SDK Reference Easy to Find in Documentation Page #98

Open
krapie opened this issue Aug 21, 2023 · 3 comments
Open

Make JS SDK Reference Easy to Find in Documentation Page #98

krapie opened this issue Aug 21, 2023 · 3 comments
Labels
documentation 📔 Improvements or additions to documentation good first issue 🐤 Good for newcomers

Comments

@krapie
Copy link
Member

krapie commented Aug 21, 2023

Description:

Make the JS SDK Reference easy to find on the documentation page.

Why:

We recently found out that many new contributors seem to struggle with finding the API reference page. This is because Yorkie's API Reference page is located at the bottom of the documentation page.

The API reference page is a very informative documentation page that many developers look at to find detailed information about how to use library (service) APIs.

Especially for the JS/TS SDK, it is crucial because developers need to know what type that Yorkie API uses.

Therefore, we need to find a better way to provide an API reference page in the documentation section.

(This issue is somewhat related to #95)

@krapie
Copy link
Member Author

krapie commented Aug 21, 2023

One approach that @mojosoeun suggested is to place the API reference page in the menu tap on the documentation page, like Firebase.

Screen_Shot_2023-08-21_at_11 35 34_AM

@hackerwins hackerwins added the documentation 📔 Improvements or additions to documentation label Aug 21, 2023
@hackerwins hackerwins added the good first issue 🐤 Good for newcomers label Oct 26, 2023
@hackerwins
Copy link
Member

I'm also sympathizing with this issue. Feel free to send a PR for this.

@krapie
Copy link
Member Author

krapie commented Nov 9, 2023

@banma1234 Somewhat related to your previous suggestions about documentation of JS SDK.

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 good first issue 🐤 Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants