Update doc site and SDK related recommendations #477
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 4 commits
November 7, 2024 13:31
…ar. Add overview of client and core SDKs on documentation site. Add installation guide for legacy SDK.
calintje
requested review from
yugure-orca,
wjthieme and
odcheung
as code owners
wjthieme
approved these changes
Nov 7, 2024
README.md
Outdated
|
|
||
| For specific use-cases you can opt for integrating with lower level packages such as: | ||
| * `@orca-so/whirlpools-client` & `orca_whirlpools_client` - auto-generated client for the Whirlpools program that contains account, instruction and error parsing. | ||
| * `@orca-so/whirlpools-core` & `orca_whirlpools_core` - utility, math and quoting functions used by other packages. | ||
|
|
||
| ### Legacy | ||
| The legacy Typescript SDK (`@orca-so/whirlpools-sdk`) is still available for use. |
There was a problem hiding this comment.
Maybe add here that if you are using web3.js <2 you should also use this (since you cannot use the new one)
| @@ -4,7 +4,7 @@ | |||
|  | |||
|
|
|||
| ## WhirlpoolsConfig | |||
| The owner of a Config account has the authority to define the many authorities over the pools that it owns (ex. default fees, collect protocol fees etc) . Whirlpools visible on the ORCA UI are all derived and controlled by a WhirlpoolsConfig account owned by the ORCA foundation. To learn more about managing pools, start [here](../03-Whirlpools%20SDK/02-Whirlpool%20Management/01-Create%20Pool.md). | |||
| The owner of a Config account has the authority to define the many authorities over the pools that it owns (ex. default fees, collect protocol fees etc) . Whirlpools visible on the ORCA UI are all derived and controlled by a WhirlpoolsConfig account owned by the ORCA foundation. To learn more about managing pools, start [here](../03-Whirlpools%20SDKs/03-Whirlpools/03-Whirlpool%20Management/01-Create%20Pool.md). | |||
There was a problem hiding this comment.
nit: percent encoding in the url looks kinda ugly here. Is it needed?
| @@ -1,28 +1,11 @@ | |||
| import DocCard from '@theme/DocCard'; | |||
There was a problem hiding this comment.
Does this still need a separate page since it just refers to the same package
There was a problem hiding this comment.
Probably not. I will remove it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Title
Update doc site and SDK related recommendations
Details