Browse Source

Add umi interfaces page + metadata (#43)

* add missing interface link

* add missing metadata
MarkSackerberg 1 year ago
parent
commit
850572269d

+ 3 - 2
src/components/products/umi/index.js

@@ -37,12 +37,13 @@ export const umi = {
             { title: 'Accounts', href: '/umi/accounts' },
             { title: 'Helpers', href: '/umi/helpers' },
             { title: 'HTTP Requests', href: '/umi/http-requests' },
-            { title: 'Implentations', href: '/umi/implementations' },
+            { title: 'Interfaces', href: '/umi/interfaces' },
+            { title: 'Implementations', href: '/umi/implementations' },
             { title: 'Kinobi', href: '/umi/kinobi' },
             { title: 'Plugins', href: '/umi/plugins' },
             { title: 'Programs', href: '/umi/programs' },
             {
-              title: 'PubicKeys and Signers',
+              title: 'PublicKeys and Signers',
               href: '/umi/public-keys-and-signers',
             },
             { title: 'RPC', href: '/umi/rpc' },

+ 5 - 1
src/pages/umi/accounts.md

@@ -1,4 +1,8 @@
-# Fetching accounts
+---
+title: Fetching Accounts
+metaTitle: Umi - Fetching Accounts
+description: How to fetch Accounts using Umi
+---
 
 Let's see how we can fetch account data from the Solana blockchain using Umi. For that, we will need the [`RpcInterface`](https://umi-docs.vercel.app/interfaces/umi.RpcInterface.html) to fetch accounts with serialized data and [serializers](./serializers.md) to help deserialize them.
 

+ 1 - 1
src/pages/umi/getting-started/index.md

@@ -1,7 +1,7 @@
 ---
 title: Getting Started
 metaTitle: Umi - Getting Started
-description: A Javascript for Solana.
+description: A Javascript Framework for Solana.
 ---
 
 # Installation

+ 5 - 2
src/pages/umi/helpers.md

@@ -1,5 +1,8 @@
-# Umi helpers
-
+---
+title: Umi helpers
+metaTitle: Umi - Umi helpers
+description: Overview over Helpers built into Umi
+---
 On top of the core interfaces, Umi provides a set of helper functions that can be used to make working with Solana programs easier.
 
 ## Amounts

+ 5 - 2
src/pages/umi/http-requests.md

@@ -1,5 +1,8 @@
-# Sending Http requests
-
+---
+title: Sending Http requests
+metaTitle: Umi - Sending Http requests
+description: Sending Http requests using Metaplex Umi
+---
 Umi provides a simple `HttpInterface` that can be used to send HTTP requests. This allows any Umi plugin or third-party library to rely on whichever Http client the end-user chooses to use instead of ending up with multiple Http clients in the same project.
 
 The `HttpInterface` only defines a single method `send` which accepts a generic `HttpRequest<T>` and returns a generic `HttpResponse<U>` such that `T` and `U` are the request and response body types respectively.

+ 5 - 2
src/pages/umi/implementations.md

@@ -1,5 +1,8 @@
-# Interface implementations
-
+---
+title: Interface implementations
+metaTitle: Umi - Interface Implementations
+description: Overview over Public Interface Implementations
+---
 The page aims to list all the available implementations of [the interfaces defined by Umi](./interfaces.md) page.
 
 ## Bundles

+ 5 - 2
src/pages/umi/interfaces.md

@@ -1,5 +1,8 @@
-# Umi's interfaces
-
+---
+title: Umi's Interfaces
+metaTitle: Umi - Umi's Interfaces
+description: Overview over Umi's Interfaces
+---
 ## The core interfaces
 
 Umi defines a set of core interfaces that makes it easy to interact with the Solana blockchain. Namely, they are:

+ 5 - 2
src/pages/umi/kinobi.md

@@ -1,5 +1,8 @@
-# Generating Umi clients via Kinobi
-
+---
+title: Generating Umi clients via Kinobi
+metaTitle: Umi - Generating Umi clients via Kinobi
+description: Generating Umi clients via Kinobi
+---
 The Umi framework provides the basis for building Solana clients in JavaScript. It becomes a lot more powerful when programs offer Umi-compatible libraries as it allows end-users to simply plug their Umi instance into whichever helper functions they provide. To simplify and automate the process of creating Umi-compatible libraries, Umi provides a powerful code generator called Kinobi.
 
 [Kinobi](https://github.com/metaplex-foundation/kinobi) introduces a language-agnostic representation of Solana clients which can be composed of one or several programs. It does this by using a tree of nodes that can be visited by `Visitor` classes. Visitors can be used to update any aspect of the tree allowing developers to tailor the client to their needs. Once the tree is to the developer's liking, language-specific visitors can be used to generate the code for the target language or framework.

+ 5 - 2
src/pages/umi/plugins.md

@@ -1,5 +1,8 @@
-# Umi plugins
-
+---
+title: Umi Plugins
+metaTitle: Umi - Plugins
+description: Plugins in Metaplex Umi
+---
 Whilst Umi is a small zero-dependency framework, it is designed to be extended with plugins. Plugins allow us to not only interact with its interfaces or swap out its interface implementations but also to add new features to Umi itself.
 
 ## Using plugins

+ 5 - 2
src/pages/umi/programs.md

@@ -1,5 +1,8 @@
-# Registering programs
-
+---
+title: Registering Programs
+metaTitle: Umi - Registering Programs
+description: Registering Programs to Metaplex Umi
+---
 In order to create clients that interact with Solana programs, it is important to know which programs are available within your cluster and at which address. Umi offers a `ProgramRepositoryInterface` that acts as one big registry of programs for you client.
 
 This also allows us to:

+ 5 - 2
src/pages/umi/public-keys-and-signers.md

@@ -1,5 +1,8 @@
-# Public keys and signers
-
+---
+title: Public keys and signers
+metaTitle: Umi - Public keys and signers
+description: Public keys and signers in Metaplex Umi
+---
 On this page, we'll see how to manage public keys and signers in Umi which is partially made possible by the EdDSA interface.
 
 The [EdDSA interface](https://umi-docs.vercel.app/interfaces/umi.EddsaInterface.html) is used to create keypairs, find PDAs and sign/verify messages using the EdDSA algorithm. We can either use this interface directly and/or use helper methods that delegate to this interface to provide a better developer experience.

+ 1 - 1
src/pages/umi/recipes/index.md

@@ -1,7 +1,7 @@
 ---
 title: Recipes
 metaTitle: Umi - Recipes
-description: How-to guides for Metaplex's Toolbox product.
+description: How-to guides for Metaplex's Umi product.
 ---
 
 ## Passing Transactions from Backend to Frontend (and vice versa)

+ 1 - 1
src/pages/umi/references/index.md

@@ -1,7 +1,7 @@
 ---
 title: API References
 metaTitle: Umi - API References
-description: References and code snippets for Metaplex's Toolbox product.
+description: References and code snippets for Metaplex's Umi product.
 ---
 
 _Coming soon..._

+ 5 - 2
src/pages/umi/rpc.md

@@ -1,5 +1,8 @@
-# Connecting with an RPC
-
+---
+title: Connecting with an RPC
+metaTitle: Umi - Connecting with an RPC
+description: Connecting with an RPC using Metaplex Umi
+---
 Contacting the Solana blockchain via an RPC is an important part of any decentralized application. Umi provides a [RpcInterface](https://umi-docs.vercel.app/interfaces/umi.RpcInterface.html) that helps us do just that.
 
 ## Configuring the RPC's endpoint

+ 5 - 2
src/pages/umi/serializers.md

@@ -1,5 +1,8 @@
-# Serializers
-
+---
+title: Serializers
+metaTitle: Umi - Serializers
+description: Serializers and Deserializers in Metaplex Umi
+---
 Whether we are sending data to the blockchain or reading from it, serialization is a big part of the process. The serialization logic may vary from one program to another and, whilst Borsh serialization is the most popular choice for Solana programs, it is not the only one.
 
 Umi helps with this by providing a flexible and extensible serialization framework that allows you to build your own serializers. Namely, it includes:

+ 5 - 2
src/pages/umi/storage.md

@@ -1,5 +1,8 @@
-# Uploading and downloading assets
-
+---
+title: Uploading and downloading assets
+metaTitle: Umi - Uploading and downloading assets
+description: Uploading and downloading assets using Metaplex Umi
+---
 Umi enables us to upload and download any file via the [`UploaderInterface`](https://umi-docs.vercel.app/interfaces/umi.UploaderInterface.html) and [`DownloaderInterface`](https://umi-docs.vercel.app/interfaces/umi.DownloaderInterface.html) interfaces respectively.
 
 ## Generic files

+ 5 - 0
src/pages/umi/transactions.md

@@ -1,3 +1,8 @@
+---
+title: Sending transactions
+metaTitle: Umi - Sending transactions
+description: Sending transactions using Metaplex Umi and Transaction Builders
+---
 Managing and sending transactions is an important part of any Solana client. To help manage them, Umi provides a bunch of components:
 
 - A [TransactionFactoryInterface](https://umi-docs.vercel.app/interfaces/umi.TransactionFactoryInterface.html) that can be used to create and (de)serialize transactions.

+ 5 - 2
src/pages/umi/web3js-adapters.md

@@ -1,5 +1,8 @@
-# Web3.js adapters
-
+---
+title: Web3.js adapters
+metaTitle: Umi - Web3.js adapters
+description: Adapters to make Metaplex Umi work with Solana web3js.
+---
 The `@solana/web3.js` library is currently widely used in the Solana ecosystem and defines its own types for public keys, transactions, instructions, etc.
 
 When creating Umi, we wanted to move away from the class-based types defined in `@solana/web3.js` and instead use a more functional approach by relying only on TypeScript types. This unfortunately means that not all types from `@solana/web3.js` are compatible with the ones provided by Umi and vice versa.