Skip to content

Commit

Permalink
more friendly developers stection structure #104
Browse files Browse the repository at this point in the history
  • Loading branch information
jeemclr committed Jan 2, 2023
1 parent 62581a7 commit a6fb962
Show file tree
Hide file tree
Showing 15 changed files with 59 additions and 117 deletions.
9 changes: 9 additions & 0 deletions docs/for-developers/Getting Started/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"label": "Getting Started",
"position": 2,
"link": {
"type": "generated-index"
}
}


File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@
sidebar_position: 2
---

# Getting Started
# Installation

___

## Ternoa-js SDK ⚙️
<!-- ## Ternoa-js SDK ⚙️
>**[Ternoa-js SDK](https://github.com/capsule-corp-ternoa/ternoa-js)** has been thought with one intention: **it aims to be one of the easiest tool to build web3 projects on top of the Ternoa Chain**.
Expand All @@ -16,7 +14,7 @@ Based on **Polkadot.js API** and **Javascript**, it offers application developer
You can submit any transaction to the chain to manage your NFTs or familiarize yourself with our helpers with the code snippets.
This application aims to be build by the community and is **the perfect entry door to learn how to use Ternoa SDK**, your contribution and interest are warm welcomed.
If you look for more global information about Ternoa, check our **[website](https://www.ternoa.network/)**.
If you look for more global information about Ternoa, check our **[website](https://www.ternoa.network/)**. -->

## Installation ⌨️

Expand Down
File renamed without changes.
7 changes: 7 additions & 0 deletions docs/for-developers/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"label": "For Developers",
"position": 4,
"link": {
"type": "generated-index"
}
}
File renamed without changes.
16 changes: 16 additions & 0 deletions docs/for-developers/cookbook/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
sidebar_position: 5
sidebar_label: Cookbook
---

# Cookbook

This section covers some basic use cases. These _**code snippets**_ allow you to discover the different way to use/interact with a feature, some options and best practices, and provides crusty information.

_If you are looking for full exemple instead of short code snippets,_ you rather look at our [Ternoa-js dApp](https://e2e.ternoa.network/) and [gitHub](https://github.com/capsule-corp-ternoa/ternoa-js-test-dapp) repo. Depending of the community requests and feedback, we will implement more of those cookbook examples and make them available for everyone below.

```mdx-code-block
import DocCardList from '@theme/DocCardList';
<DocCardList />
```
File renamed without changes.
File renamed without changes.
63 changes: 0 additions & 63 deletions docs/for-developers/e2e.md

This file was deleted.

20 changes: 3 additions & 17 deletions docs/for-developers/index.md → docs/for-developers/faq.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,9 @@
---
sidebar_position: 4
sidebar_label: For Developers
sidebar_position: 5
sidebar_label: FAQ
---

# For Developers

## Overview

Let's learn about the most important tools to build on top of Ternoa chain!

```mdx-code-block
import DocCardList from '@theme/DocCardList';
<DocCardList />
```

The sections above will provide you with all you need to know to install and use [Ternoa-JS SDK](/category/javascript-sdk), [Indexer](/category/indexer) and [Dictionary](/for-developers/indexer/dictionary/). The following [FAQ](#faq) answers common questions about which tool to use.

## FAQ
# FAQ

### When should I use Ternoa-JS getters or Indexer queries to get on-chain data?

Expand Down
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
---
sidebar_position: 1
description: Welcome to the Ternoa developer documentation.
---

# Introduction

___
Welcome to the Ternoa developer documentation.

## Overview ⚙️

Welcome to the Ternoa-js developer documentation. Ternoa-js main objective is to be: **one of the most user-friendly tools to build web3 projects** on top of the Ternoa Chain. Based on Polkadot{.js} API and Javascript, it offers developers the ability to query and interact with substrate chains like the Ternoa chain. It provides a seamless experience and allows you to start building at a glance: an extra short init and just a few lines of code, and your first NFT will be live on the chain.
In Ternoa we have provided a seamless experience building a Javascirpt SDK `ternoa-js` to allow any developer to start building at a glance: an extra short init and just a few lines of code, and your first NFT will be live on the network.

`ternoa-js` main objective is to be: **one of the most user-friendly tools to build web3 projects** on top of the Ternoa Chain. Based on Polkadot{.js} API and Javascript, it offers developers the ability to query and interact with the Ternoa network.



### Forward Together

Ternoa-js is an open-source project. Feel free to interact and move forward with us. If you have questions about anything related to Ternoa, need help, or want to request features, you can open a discussion on our [GitHub Discussions]([https://github.com/capsule-corp-ternoa/ternoa-js/discussions](https://github.com/capsule-corp-ternoa/ternoa-js/discussions)) And if you find an issue, lets us know in our [GitHub Issues]([https://github.com/capsule-corp-ternoa/ternoa-js/issues](https://github.com/capsule-corp-ternoa/ternoa-js/issues)) section.
`ternoa-js` is an open-source project. Feel free to interact and move forward with us. If you have questions about anything related to Ternoa, need help, or want to request features, you can open a discussion on our [GitHub Discussions]([https://github.com/capsule-corp-ternoa/ternoa-js/discussions](https://github.com/capsule-corp-ternoa/ternoa-js/discussions)) And if you find an issue, lets us know in our [GitHub Issues]([https://github.com/capsule-corp-ternoa/ternoa-js/issues](https://github.com/capsule-corp-ternoa/ternoa-js/issues)) section.

## API Architecture

Expand Down Expand Up @@ -40,6 +45,4 @@ For those familiar with Polkadot, you will quickly recognize the design structur

As it makes sense for us to provide the most accessible tools to build on the Ternoa chain, **we also tried to simplify the response format of our functions whenever we could**. Depending if you want to get things done for you or if you go with the fully customizable way and handle your callback, we invite you to choose the correct function: _Events and features datas will be provided directly on some function while only transaction hash hex will be returned on others._ We will cover this topic later in the doc.

## Ready to discover more?

If you are looking for full examples or short code snippet, move to the Cookbook to get a look at our most common use-cases or go to the [e2e Test dApp](https://e2e.ternoa.network/) and [github](https://github.com/capsule-corp-ternoa/ternoa-js-test-dapp) repository to get a full example.
### Ready to discover more?
12 changes: 12 additions & 0 deletions docs/for-developers/playground.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
sidebar_position: 4
sidebar_label: Playground
---

# 🧩 Playground

Our E2E App allow you to play with our SDK getting snippet code for your project.

:::tip
Use [e2e.ternoa.network](https://e2e.ternoa.network/app/NFT/CreateNFT) as an easy-to-remember shortcut.
:::
10 changes: 0 additions & 10 deletions docs/for-developers/sdk/_category_.json

This file was deleted.

16 changes: 0 additions & 16 deletions docs/for-developers/sdk/cookbook/index.md

This file was deleted.

0 comments on commit a6fb962

Please sign in to comment.