From 9e5523c79d028319b9a1458aa7c4d94a985bb41b Mon Sep 17 00:00:00 2001 From: Conner Gallagher Date: Tue, 9 May 2023 22:26:40 -0600 Subject: [PATCH] consolidated .docs --- .docs/{libraries.yaml => clients.yaml} | 4 +- .../javascript/solana.js}/README.template.md | 0 .../solana.js}/usage/create-queue.ts | 0 .../solana.js}/usage/load-program.ts | 0 .../javascript/solana.js}/usage/meta.yaml | 0 .../anchor-buffer-parser}/README.template.md | 0 .../anchor-feed-parser}/README.template.md | 0 .docs/rust/switchboard-v2/README.template.md | 36 +++++++++++++ .../rust/switchboard-v2}/usage/meta.yaml | 0 .../rust/switchboard-v2}/usage/read-result.rs | 0 rust/switchboard-v2/.docs/README.template.md | 52 ------------------- 11 files changed, 39 insertions(+), 53 deletions(-) rename .docs/{libraries.yaml => clients.yaml} (89%) rename {javascript/solana.js/.docs => .docs/javascript/solana.js}/README.template.md (100%) rename {javascript/solana.js/.docs => .docs/javascript/solana.js}/usage/create-queue.ts (100%) rename {javascript/solana.js/.docs => .docs/javascript/solana.js}/usage/load-program.ts (100%) rename {javascript/solana.js/.docs => .docs/javascript/solana.js}/usage/meta.yaml (100%) rename {programs/anchor-buffer-parser/.docs => .docs/programs/anchor-buffer-parser}/README.template.md (100%) rename {programs/anchor-feed-parser/.docs => .docs/programs/anchor-feed-parser}/README.template.md (100%) create mode 100644 .docs/rust/switchboard-v2/README.template.md rename {rust/switchboard-v2/.docs => .docs/rust/switchboard-v2}/usage/meta.yaml (100%) rename {rust/switchboard-v2/.docs => .docs/rust/switchboard-v2}/usage/read-result.rs (100%) delete mode 100644 rust/switchboard-v2/.docs/README.template.md diff --git a/.docs/libraries.yaml b/.docs/clients.yaml similarity index 89% rename from .docs/libraries.yaml rename to .docs/clients.yaml index a4588af..8550028 100644 --- a/.docs/libraries.yaml +++ b/.docs/clients.yaml @@ -1,9 +1,11 @@ -libraries: +clients: - name: "switchboard-v2" + slug: "./" description: "A Rust library to interact with Switchboard V2 accounts on Solana." language: "rust" path: "rust/switchboard-v2" - name: "@switchboard-xyz/solana.js" + slug: "./" description: "A Typescript client to interact with Switchboard on Solana." language: "javascript" path: "javascript/solana.js" diff --git a/javascript/solana.js/.docs/README.template.md b/.docs/javascript/solana.js/README.template.md similarity index 100% rename from javascript/solana.js/.docs/README.template.md rename to .docs/javascript/solana.js/README.template.md diff --git a/javascript/solana.js/.docs/usage/create-queue.ts b/.docs/javascript/solana.js/usage/create-queue.ts similarity index 100% rename from javascript/solana.js/.docs/usage/create-queue.ts rename to .docs/javascript/solana.js/usage/create-queue.ts diff --git a/javascript/solana.js/.docs/usage/load-program.ts b/.docs/javascript/solana.js/usage/load-program.ts similarity index 100% rename from javascript/solana.js/.docs/usage/load-program.ts rename to .docs/javascript/solana.js/usage/load-program.ts diff --git a/javascript/solana.js/.docs/usage/meta.yaml b/.docs/javascript/solana.js/usage/meta.yaml similarity index 100% rename from javascript/solana.js/.docs/usage/meta.yaml rename to .docs/javascript/solana.js/usage/meta.yaml diff --git a/programs/anchor-buffer-parser/.docs/README.template.md b/.docs/programs/anchor-buffer-parser/README.template.md similarity index 100% rename from programs/anchor-buffer-parser/.docs/README.template.md rename to .docs/programs/anchor-buffer-parser/README.template.md diff --git a/programs/anchor-feed-parser/.docs/README.template.md b/.docs/programs/anchor-feed-parser/README.template.md similarity index 100% rename from programs/anchor-feed-parser/.docs/README.template.md rename to .docs/programs/anchor-feed-parser/README.template.md diff --git a/.docs/rust/switchboard-v2/README.template.md b/.docs/rust/switchboard-v2/README.template.md new file mode 100644 index 0000000..38f6461 --- /dev/null +++ b/.docs/rust/switchboard-v2/README.template.md @@ -0,0 +1,36 @@ +
+ + + + +

switchboard-v2

+ +

A Rust library to interact with Switchboard accounts on Solana.

+ +

+ + Crates.io + +

+
+ +## Install + +Run the following Cargo command in your project directory: + +```bash +cargo add switchboard-v2 +``` + +Or add the following line to your Cargo.toml: + +```toml +[dependencies] +switchboard-v2 = "0.1.23" +``` + +## Usage + + + + diff --git a/rust/switchboard-v2/.docs/usage/meta.yaml b/.docs/rust/switchboard-v2/usage/meta.yaml similarity index 100% rename from rust/switchboard-v2/.docs/usage/meta.yaml rename to .docs/rust/switchboard-v2/usage/meta.yaml diff --git a/rust/switchboard-v2/.docs/usage/read-result.rs b/.docs/rust/switchboard-v2/usage/read-result.rs similarity index 100% rename from rust/switchboard-v2/.docs/usage/read-result.rs rename to .docs/rust/switchboard-v2/usage/read-result.rs diff --git a/rust/switchboard-v2/.docs/README.template.md b/rust/switchboard-v2/.docs/README.template.md deleted file mode 100644 index cd2dd77..0000000 --- a/rust/switchboard-v2/.docs/README.template.md +++ /dev/null @@ -1,52 +0,0 @@ -
- - - - -

switchboard-v2

- -

A Rust library to interact with Switchboard V2 accounts on Solana.

- -

- - Crates.io - -

- -

- - Discord - - - Twitter - -

- -

- Typedocs: docs.rs/switchboard-v2 -

-

- Sbv2 Solana SDK: github.com/switchboard-xyz/sbv2-solana -

-
- -## Install - -Run the following Cargo command in your project directory: - -```bash -cargo add switchboard-v2 -``` - -Or add the following line to your Cargo.toml: - -```toml -[dependencies] -switchboard-v2 = "0.1.23" -``` - -## Usage - - - -