Skip to content

Commit 97b4f7d

Browse files
mrcnkmrcnk
committed
feat(minajs): add some initial docs
1 parent f02776b commit 97b4f7d

File tree

8 files changed

+83
-3
lines changed

8 files changed

+83
-3
lines changed

‎apps/docs/docs/pages/about.mdx

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# About MinaJS [Learn about MinaJS and Klesia.]
2+
3+
MinaJS is a TypeScript interface for Mina Protocol. It provides a set of TypeScript types and utilities to interact with Mina Protocol. MinaJS is the missing piece for your smooth zkApp development on Mina.
4+
It aims to remove the complexities, and allow developers to focus on building innovative zkApps on Mina.
5+
6+
## Services
7+
8+
MinaJS provides a set of services to interact with Mina Protocol. The services are designed to be modular and extensible. The services are:
9+
10+
- **MinaJS Connect** - A connector library to discover Mina Protocol wallets like Pallad, and interact with them in a seamless way.
11+
- **MinaJS Accounts** - A Viem-like library to manage accounts and execute operations such as signing transactions.
12+
- **MinaJS Provider** - A set of Zod-based schemas and TypeScript types for Mina wallets to comply with the latest specs and MinaJS Connect standard.
13+
- **Klesia** - A JSON-RPC wrapper over Mina Node's GraphQL API, similar to APIs like Alchemy and Infura. It's self hostable, so you can bring your own infrastructure.
14+
- **Klesia SDK** - A TypeScript SDK to interact with Klesia JSON-RPC API with type-safe interfaces and properties auto-completion.
15+
16+
## Supported Chains
17+
18+
- Mina Mainnet
19+
- Mina Devnet
20+
- [Zeko](https://zeko.io) Devnet (soon™️)
21+
22+
## Supported Rollup Frameworks
23+
24+
- [Protokit](https://protokit.dev/) (soon™️)
25+
26+
## Supported Wallets
27+
28+
- [Pallad](https://get.pallad.co/website)
29+
- [Auro Wallet](https://www.aurowallet.com/) (soon™️)

‎apps/docs/docs/pages/accounts/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
#TODO

‎apps/docs/docs/pages/connect/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
#TODO

‎apps/docs/docs/pages/faq.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Frequently Asked Questions
2+
3+
## Who created MinaJS?
4+
5+
MinaJS is created by [Palladians](https://palladians.xyz), a team of developers and designers building tools and services for the Mina community.
6+
7+
## I would like to contribute to MinaJS. How can I get started?
8+
9+
Reach out to us on [Pallad's Discord](https://get.pallad.co/discord) or send us an email at [email protected]. We will help you to get started.
10+
11+
## I would like to get a new feature added to MinaJS. How can I request it?
12+
13+
Please open a discussion in [the repository](https://github.com/palladians/mina-js) or message us on our [Discord](https://get.pallad.co/discord).

‎apps/docs/docs/pages/getting-started.mdx

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,30 @@
1-
# Get started
1+
# Get started [Get up to speed with MinaJS and Klesia.]
22

3-
Hello world!
3+
MinaJS is a set of packages and apps built by our team. The aim is to provide a modular solution, where you only pick elements necessary for your zkApp.
4+
5+
## SDKs
6+
7+
- `@mina-js/connect`
8+
- `@mina-js/accounts`
9+
- `@mina-js/klesia-sdk`
10+
11+
## Installation
12+
13+
The libraries are available on npm. You can install them using npm, yarn, pnpm, and bun (yep, we support Bun).
14+
15+
```bash
16+
# Install MinaJS Connect
17+
$ npm install @mina-js/connect
18+
19+
# Install MinaJS Accounts
20+
$ npm install @mina-js/accounts
21+
22+
# Install Klesia SDK
23+
$ npm install @mina-js/klesia-sdk
24+
```
25+
26+
## SDK specific usage
27+
28+
- [MinaJS Connect](/connect)
29+
- [MinaJS Accounts](/accounts)
30+
- [Klesia SDK](/klesia-sdk)

‎apps/docs/docs/pages/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import { GithubIcon } from 'lucide-react'
1111
<h1 className="font-bold text-3xl lg:text-6xl leading-[3rem] lg:leading-[5rem]">The TypeScript interface for <span className="bg-clip-text text-transparent bg-gradient-to-r from-indigo-400 to-fuchsia-400 dark:from-indigo-300 dark:to-fuchsia-200">Mina Protocol</span>.</h1>
1212
<p className="text-lg lg:text-xl">MinaJS is the missing piece for your smooth zkApp development on Mina.</p>
1313
<div className="flex gap-2">
14-
<a href="/getting-started" className="btn lg:btn-lg btn-primary rounded-full">Get Started</a>
14+
<a href="/about" className="btn lg:btn-lg btn-primary rounded-full">Get Started</a>
1515
<a href="https://github.com/palladians/mina-js" target="_blank" rel="noopener noreferrer" className="btn lg:btn-lg btn-outline border-neutral text-neutral dark:border-primary dark:text-primary rounded-full">
1616
<GithubIcon />
1717
<span>GitHub</span>

‎apps/docs/docs/pages/klesia-sdk/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
#TODO

‎apps/docs/vocs.config.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,18 @@ export default defineConfig({
4747
],
4848
topNav: [{ text: "Pallad", link: "https://get.pallad.co/website" }],
4949
sidebar: [
50+
{
51+
text: "About MinaJS",
52+
link: "/about",
53+
},
5054
{
5155
text: "Getting Started",
5256
link: "/getting-started",
5357
},
58+
{
59+
text: "FAQ",
60+
link: "/faq",
61+
},
5462
{
5563
text: "MinaJS Connect",
5664
link: "/connect",

0 commit comments

Comments
 (0)