Minor documentation updates (#679)

* Update API docs link. Update Rust SDK version compatibility. Fix logo bug. Update general README

* Improve formatting of version references

* Fix

* Update readme lp bot

* Add changesets

Author: calintje

.changeset/empty-ants-roll.md

@@ -0,0 +1,5 @@
+---
+"@orca-so/whirlpools-docs-rust": patch
+---
+
+Updated the Solana SDK compatibility version for Rust SDKs.

.changeset/fair-wombats-kneel.md

@@ -0,0 +1,5 @@
+---
+"@orca-so/whirlpools-example-rust-repositioning-bot": patch
+---
+
+Updated installation guide.

.changeset/good-icons-beg.md

@@ -0,0 +1,5 @@
+---
+"@orca-so/whirlpools-docs": patch
+---
+
+Updated Solana SDK version compatibility for Rust SDKs. Updated API docs reference. Fixed a bug causing the Orca logo to appear streched on Safari.

README.md

@@ -34,7 +34,6 @@ This monorepo contains all the code needed to build, deploy and interact with th
 
 ### Requirements
 
-- Rust 1.78.0
 - Anchor v0.29.0
 - Solana v1.17.22
 

docs/rust/README.md

@@ -4,11 +4,11 @@
 
 The Whirlpools SDKs are Orca's primary set of SDKs designed to provide enhanced, modular interaction with the Whirlpool Program on Solana and Eclipse. Whether you are managing liquidity, building applications that require pool infrastructure, or building automation tools that interact with the program, our SDKs cover a spectrum of functionality from low-level granular control to high-level abstractions. This offering is divided into three main components:
 
-### 1. High-Level SDK (in development, requires Solana SDK v1.18)
+### 1. High-Level SDK, compatible with Solana SDK versions `^1.18.0` but `<2.0.0`
 The High-Level SDK is our top recommendation for anyone who wants to integrate with the Whirlpool Program. It builds upon the Low-Level and Core SDKs to provide an easy-to-use interface for interacting with the Whirlpool Program. This SDK abstracts many of the underlying complexities, such as tick array management, and makes managing pools and positions, and executing swaps much simpler. It is suitable for developers who need efficient, high-level functionalities and want to minimize manual configuration and management.
 
 ### 2. Core SDK
 The Core SDK provides essential utilities for math operations and quotes, required for working with liquidity pools. This library focuses on calculations such as determining position status, price conversions, and computing quotes on adjusting liquidity and swaps. It is written in Rust but has been compiled to WebAssembly (Wasm) for easy integration into TypeScript projects.
 
-### 3. Low-Level SDK (requires Solana SDK \<v2)
+### 3. Low-Level SDK, compatible with Solana SDK versions `^1.16.0` but `<2.0.0`
 The Low-Level SDK is autogenerated from the Whirlpool Program's Interface Description Language (IDL). This SDK provides direct program interactions and is designed for developers who need complete, low-level control over Whirlpool operations. It covers direct access to Solana accounts, instructions, and transactions.

docs/whirlpool/docs/01-Welcome.mdx

@@ -28,8 +28,8 @@ What follows is a brief overview of our SDK suite, distinguishing between the Wh
 The Whirlpools SDKs are our primary set of SDKs designed to provide enhanced, modular interaction with the Whirlpool Program. This offering is divided into three main components:
 
 #### 1. High-Level SDK
-- **TypeScript**: [@orca-so/whirlpools](https://www.npmjs.com/package/@orca-so/whirlpools) (Requires Solana Web3.js SDK ≥v2.0)
-- **Rust**: orca_whirlpools (requires Solana SDK v1.18)
+- **TypeScript**: [@orca-so/whirlpools](https://www.npmjs.com/package/@orca-so/whirlpools) (Compatible with Solana Web3.js SDK version `^2.0`)
+- **Rust**: [orca_whirlpools](https://crates.io/crates/orca_whirlpools) (Compatible with Solana SDK versions `^1.18.0` but `<2.0.0`)
 - **Description**: The High-Level SDK is our top recommendation for anyone who wants to integrate with the Whirlpool Program. It builds upon the Low-Level and Core SDKs to provide an easy-to-use interface for interacting with the Whirlpool Program. This SDK abstracts many of the underlying complexities, such as tick array management, and makes managing pools and positions, and executing swaps much simpler. It is suitable for developers who need efficient, high-level functionalities and want to minimize manual configuration and management.
 
 #### 2. Core SDK
@@ -38,12 +38,12 @@ The Whirlpools SDKs are our primary set of SDKs designed to provide enhanced, mo
 - **Description**: The Core SDK provides essential utilities for math operations and quotes, required for working with liquidity pools. This library focuses on calculations such as determining position status, price conversions, and computing quotes on adjusting liquidity and swaps. It is written in Rust but has been compiled to WebAssembly (Wasm) for easy integration into TypeScript projects.
 
 #### 3. Low-Level SDK
-- **TypeScript**: [@orca-so/whirlpools-client](https://www.npmjs.com/package/@orca-so/whirlpools-client) (Requires Solana Web3.js SDK ≥v2.0)
-- **Rust**: [orca_whirlpools_client](https://crates.io/crates/orca_whirlpools_client) (Requires Solana SDK \<v2)
+- **TypeScript**: [@orca-so/whirlpools-client](https://www.npmjs.com/package/@orca-so/whirlpools-client) (Compatible with Solana Web3.js SDK version `^2.0`)
+- **Rust**: [orca_whirlpools_client](https://crates.io/crates/orca_whirlpools_client) (Compatible with Solana SDK versions `^1.16.0` but `<2.0.0`)
 - **Description**: The Low-Level SDK is autogenerated from the Whirlpool Program's Interface Description Language (IDL) using Codama. This SDK provides direct program interactions and is designed for developers who need complete, low-level control over Whirlpool operations. It covers direct access to Solana accounts, instructions, and transactions.
 
 ### Legacy SDK
-- **TypeScript**: [@orca-so/whirlpools-sdk](https://www.npmjs.com/package/@orca-so/whirlpools-sdk) (Requires Solana Web3.js SDK \<v2.0)
+- **TypeScript**: [@orca-so/whirlpools-sdk](https://www.npmjs.com/package/@orca-so/whirlpools-sdk) (Requires Solana Web3.js SDK `<v2.0`)
 - **Description**: Despite being called "Legacy", this SDK remains a reliable choice for integrating with projects that use Solana Web3.js versions older than v2.0. It offers foundational tools for interacting with Orca's Whirlpool Program and includes utilities from @orca-so/common-sdk.
 
 ## How to use this documentation

docs/whirlpool/docs/05-More Resources/04-API.mdx

@@ -1,20 +1,14 @@
 ---
 sidebar-label: API
 ---
-import DocCard from '@theme/DocCard';
+import DocCard from "@theme/DocCard";
 
-# API Endpoints
+# API
+Read and test endpoints through the Orca's public API documentation to learn more about the available endpoints and how to interact with them.
 
 <DocCard item={{
-  type: 'link',
-  href: 'https://api.mainnet.orca.so/v1/whirlpool/list',
-  label: 'Whirlpool List',
-  description: 'https://api.mainnet.orca.so/v1/whirlpool/list'
+  type: "link",
+  href: "https://api.orca.so/docs",
+  label: "Orca's public API",
+  description: "https://api.mainnet.orca.so/v1/whirlpool/list"
 }} />
-
-<DocCard item={{
-  type: 'link',
-  href: 'https://api.mainnet.orca.so/v1/token/list',
-  label: 'Token List',
-  description: 'https://api.mainnet.orca.so/v1/token/list'
-}} />

docs/whirlpool/static/index.css

@@ -27,7 +27,6 @@
 
 img {
   display: block;
-  width: 100%;
   margin-left: auto;
   margin-right: auto;
-}
+}

examples/rust-sdk/whirlpool_repositioning_bot/README.md

@@ -25,19 +25,22 @@ A Rust-based CLI bot for interacting with the Orca Whirlpools program on Solana.
 1. Clone this repository:
   ```bash
   git clone https://github.com/orca-so/whirlpools.git
-  cd examples/rust-sdk/lp-bot
+  cd examples/rust-sdk/whirlpool_repositioning_bot
   ```
-2. Build the bot:
+2. Update `Cargo.toml`
+This project uses the local version of the dependencies. If you want to move this example project outside of this repo, update the `Cargo.toml`:
+```toml
+# other dependencies
+orca_whirlpools = { version = "^1.0" }
+orca_whirlpools_client = { version = "^1.0" }
+orca_whirlpools_core = { version = "^1.0" }
+# rest of the dependencies
+```
+3. Build the bot:
   ```bash
   cargo build --release
   ```
-3. The executable will be located in target/release/lp-bot
-
-> NOTE: This project uses the local version of the dependency. If you want to move this example project outside of this monorepo, make sure you install the necessary dependecies:
-  ```bash
-  cargo add orca_whirlpools orca_whirlpools_client orca_whirlpools_core
-  ```
-
+4. The executable will be located in target/release/whirlpool_repositioning_bot
 
 ---
 
@@ -104,7 +107,7 @@ Monitor with turbo priority fees:
 ```bash
 examples/
 ├── rust-sdk/
-    └── lp-bot/
+    └── whirlpool_repositioning_bot/
         └── src/
             ├── main.rs                 # Entry point
             ├── cli.rs                  # CLI argument parsing