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

Branch v3 js docs #1138

Merged
merged 4 commits into from
Nov 22, 2022
Merged

Branch v3 js docs #1138

merged 4 commits into from
Nov 22, 2022

Conversation

fwilhe
Copy link
Contributor

@fwilhe fwilhe commented Nov 21, 2022

Branched v3 docs for js sdk

Default (for now) is v2. V3 docs have an 'unreleased' marker.

Copy link
Contributor

@deekshas8 deekshas8 left a comment

Choose a reason for hiding this comment

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

Left some comments. I think the behavior for v2 should not be changed as long as its the default.

@FrankEssenberger
Copy link
Contributor

With the changes from the latest commit a few of the issues I found disappeared. [minor] I find the text here:
image
not optimal. If we can adjust it I would write something find documentation on the latest released version here.

@FrankEssenberger
Copy link
Contributor

Looks good overall with Deekshas suggestion all the links stay the same for v2 and work. I found one small thing. On main I still sse all the API references:
Screenshot 2022-11-22 at 10 20 23
However on this branch I see only one:
Screenshot 2022-11-22 at 10 21 07
For v3 I do not see any references which is fine I think.

@fwilhe
Copy link
Contributor Author

fwilhe commented Nov 22, 2022

@FrankEssenberger I think this is a unrelated change we discussed in a recent refinement. Not sure in which commit this was changed, but I'd be surprised if my PR caused that change. Also I think this is now the expected behaviour, so I don't know what to change.

notify @tomfrenken @marikaner @jjtang1985

anyone diagrees?

@fwilhe
Copy link
Contributor Author

fwilhe commented Nov 22, 2022

With the changes from the latest commit a few of the issues I found disappeared. [minor] I find the text here: image not optimal. If we can adjust it I would write something find documentation on the latest released version here.

It does not look like this text is customizable. I think the text is okay, but if someone knows a way to customize it we could do it. Should not be a blocker imo.

Copy link
Contributor

@deekshas8 deekshas8 left a comment

Choose a reason for hiding this comment

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

LGTM. I also do not see any difference in API Ref dropdown.
Main:
image

v3-docs branch:
image

@fwilhe fwilhe merged commit cef2cee into main Nov 22, 2022
@fwilhe fwilhe deleted the v3-docs branch November 22, 2022 11:48
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