Include low-level sdk in rustdoc/typedoc (#429)

* Include low-level sdk in rustdoc/typedoc

* Change navbar organization (#436)

Co-authored-by: calintje <[email protected]>

---------

Co-authored-by: Calin <[email protected]>
Co-authored-by: calintje <[email protected]>

Cargo.toml

@@ -5,5 +5,6 @@ members = [
 ]
 exclude = [
     "rust-sdk",
-    "ts-sdk"
+    "ts-sdk",
+    "docs"
 ]

docs/legacy/package.json

@@ -8,7 +8,6 @@
     "clean": "rimraf dist"
   },
   "devDependencies": {
-    "@orca-so/whirlpools": "*",
     "@orca-so/whirlpools-sdk": "*",
     "typedoc": "^0.26.10",
     "typescript": "^5.6.3"

docs/legacy/typedoc.json

@@ -2,5 +2,6 @@
   "entryPoints": ["../../legacy-sdk/whirlpool/src/index.ts"],
   "entryPointStrategy": "resolve",
   "githubPages": false,
+  "skipErrorChecking": true,
   "out": "dist/legacy"
 }

docs/rust/Cargo.toml

@@ -0,0 +1,11 @@
+[package]
+name = "orca_whirlpools_docs"
+version = "0.1.0"
+publish = false
+edition = "2021"
+
+[dependencies]
+orca_whirlpools_core = { path = "../../rust-sdk/core", features = ["wasm", "floats"] }
+orca_whirlpools_client = { path = "../../rust-sdk/client", features = ["anchor", "core-types"] }
+orca_whirlpools = { path = "../../rust-sdk/whirlpool" }
+

docs/rust/README.md

@@ -0,0 +1 @@
+Rust

docs/rust/package.json

@@ -3,11 +3,13 @@
   "version": "0.0.0",
   "private": true,
   "scripts": {
-    "build": "cd ../../rust-sdk/whirlpool && cargo doc --lib --no-deps && cp -rf target/doc/. ../../docs/rust/dist",
-    "start": "cd ../../rust-sdk/whirlpool && cargo doc --lib --no-deps --open",
+    "build": "cargo doc --lib --no-deps && cp -rf target/doc/. dist",
+    "start": "cargo doc --lib --no-deps --open",
     "clean": "rimraf dist"
   },
   "devDependencies": {
-    "@orca-so/whirlpools-rust": "*"
+    "@orca-so/whirlpools-rust": "*",
+    "@orca-so/whirlpools-rust-client": "*",
+    "@orca-so/whirlpools-rust-core": "*"
   }
 }

docs/rust/src/lib.rs

@@ -0,0 +1,16 @@
+#![doc = include_str!("../README.md")]
+
+pub mod orca_whirlpools_core {
+    #![doc = include_str!("../../../rust-sdk/core/README.md")]
+    pub use orca_whirlpools_core::*;
+}
+
+pub mod orca_whirlpools_client {
+    #![doc = include_str!("../../../rust-sdk/client/README.md")]
+    pub use orca_whirlpools_client::*;
+}
+
+pub mod orca_whirlpools {
+    #![doc = include_str!("../../../rust-sdk/whirlpool/README.md")]
+    pub use orca_whirlpools::*;
+}

docs/ts/README.md

@@ -0,0 +1 @@
+Typescript

docs/ts/package.json

@@ -9,8 +9,10 @@
   },
   "devDependencies": {
     "@orca-so/whirlpools": "*",
-    "@orca-so/whirlpools-sdk": "*",
+    "@orca-so/whirlpools-client": "*",
+    "@orca-so/whirlpools-core": "*",
     "typedoc": "^0.26.10",
+    "typedoc-plugin-merge-modules": "^6.0.3",
     "typescript": "^5.6.3"
   }
 }

docs/ts/typedoc.json

@@ -1,6 +1,12 @@
 {
-  "entryPoints": ["../../ts-sdk/whirlpool/src/index.ts"],
-  "entryPointStrategy": "resolve",
+  "entryPoints": [
+    "../../ts-sdk/core",
+    "../../ts-sdk/client",
+    "../../ts-sdk/whirlpool"
+  ],
+  "entryPointStrategy": "packages",
   "githubPages": false,
-  "out": "dist/ts"
+  "skipErrorChecking": true,
+  "out": "dist/ts",
+  "readme": "./README.md"
 }

docs/whirlpool/docusaurus.config.js

@@ -49,16 +49,20 @@ export default {
       items: [
         { to: "/", label: "Docs", position: "left" },
         {
-          href: "/orca_whirlpools/",
-          label: "Rust SDK Reference",
+          label: "Whirlpools SDK Reference",
           position: "left",
-          target: "_blank",
-        },
-        {
-          href: "/ts/",
-          label: "TS SDK Reference",
-          position: "left",
-          target: "_blank",
+          items: [
+            {
+              href: "/ts/",
+              label: "TS SDK Reference",
+              target: "_blank",
+            },
+            {
+              href: "/orca_whirlpools_docs/",
+              label: "Rust SDK Reference",
+              target: "_blank",
+            },
+          ],
         },
         {
           href: "/legacy/",

ts-sdk/client/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "entryPoints": [
+    "./src/index.ts"
+  ]
+}

ts-sdk/core/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "entryPoints": [
+    "./dist/nodejs/orca_whirlpools_core_js_bindings.d.ts"
+  ]
+}

ts-sdk/whirlpool/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "entryPoints": [
+    "./src/index.ts"
+  ]
+}

yarn.lock

@@ -3071,7 +3071,6 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@orca-so/whirlpools-docs-legacy@workspace:docs/legacy"
   dependencies:
-    "@orca-so/whirlpools": "npm:*"
     "@orca-so/whirlpools-sdk": "npm:*"
     typedoc: "npm:^0.26.10"
     typescript: "npm:^5.6.3"
@@ -3083,6 +3082,8 @@ __metadata:
   resolution: "@orca-so/whirlpools-docs-rust@workspace:docs/rust"
   dependencies:
     "@orca-so/whirlpools-rust": "npm:*"
+    "@orca-so/whirlpools-rust-client": "npm:*"
+    "@orca-so/whirlpools-rust-core": "npm:*"
   languageName: unknown
   linkType: soft
 
@@ -3091,8 +3092,10 @@ __metadata:
   resolution: "@orca-so/whirlpools-docs-ts@workspace:docs/ts"
   dependencies:
     "@orca-so/whirlpools": "npm:*"
-    "@orca-so/whirlpools-sdk": "npm:*"
+    "@orca-so/whirlpools-client": "npm:*"
+    "@orca-so/whirlpools-core": "npm:*"
     typedoc: "npm:^0.26.10"
+    typedoc-plugin-merge-modules: "npm:^6.0.3"
     typescript: "npm:^5.6.3"
   languageName: unknown
   linkType: soft
@@ -15548,6 +15551,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"typedoc-plugin-merge-modules@npm:^6.0.3":
+  version: 6.0.3
+  resolution: "typedoc-plugin-merge-modules@npm:6.0.3"
+  peerDependencies:
+    typedoc: 0.26.x
+  checksum: 10c0/1a1687c1dcbe521e7868384d1a58c05a9f1ebf210f55d89b6e5f386ced5d04219464909b809d29008314bf826af5e194ff75f417605497e2673c659242f16a7e
+  languageName: node
+  linkType: hard
+
 "typedoc@npm:^0.26.10":
   version: 0.26.10
   resolution: "typedoc@npm:0.26.10"