search

yorkie-team / yorkie-team.github.io

Yorkie Homepage and Documentation
https://yorkie.dev
Apache License 2.0
14 stars 15 forks source link

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

Open krapie opened 1 year ago

krapie commented 1 year ago

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 https://github.com/yorkie-team/yorkie-team.github.io/issues/95)

krapie commented 1 year ago

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 commented 10 months ago

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

krapie commented 10 months ago

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