quantus/api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Things I wish I knew... (#1374)

Browse Source 
* Make a start

* Intro

* Installation

* Flatten

* Move METHODS_*.md to substrate/*.md

* Basics

* Apply suggestions from code review

Co-Authored-By: Thibaut Sardan <33178835+Tbaut@users.noreply.github.com>

* Substrate links

* Create

* api.consts

* Typo

* Typo, ms -> md

* types.basics (SIP)

* Type basics

* api.consts jumps to api.query

* Start to api.query

* Basic queries

* Point starting to actual overview

* api.rpc

* Derive detour

* Query subs & query multi

* Apply suggestions from code review

Co-Authored-By: Thibaut Sardan <33178835+Tbaut@users.noreply.github.com>

* typo

* Query extras

* Basic transactions

* Misplaced ,

* keyring WIP

* Keyring wrap-up

* Subs SIP

* tx subs more WIP

* tx subs

* Small types cleanups

* Apply suggested changes from @JoshOrndorff

* Clarify naked await

* tx wrapping WIP

* Wrap api.wrap

* TS placeholder

* [WIP] markers for not-started

* Clarifying comments

* Additional clarifications

* types.extend... well, extended...

* Remove *nix

* Warp up TypeScript... it is it (for now)

* Some small text clarifications

* Some cleanups

* Cleanups, typos

* keyring cleanups

* Cleanups

* Wrap

* api.wrap wrapped... hopefully

* typos

* Registration typos

* typescript typos, hope I caught most...
This commit is contained in:
Jaco Greeff
2019-09-11 17:32:34 +02:00
committed by GitHub
co-authored by Thibaut Sardan
parent 3e417f4f94
commit 55fb391465
34 changed files with 1088 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/.vuepress/config.js
+30 -6
View File
@@ -22,6 +22,30 @@ module.exports = {
],
search: false,
sidebar: [
{
title: 'Getting started',
path: '/start/',
collapsable: false,
sidebarDepth: 1,
children: [
['start/install.md', 'Installation'],
['start/basics.md', 'Basics & Metadata'],
['start/create.md', 'Creating an instance'],
['start/api.consts.md', 'Using constants'],
['start/api.query.md', 'Using queries'],
['start/api.rpc.md', 'RPC calls'],
['start/api.query.subs.md', 'Query subscriptions'],
['start/api.query.multi.md', 'Multi queries'],
['start/api.query.other.md', 'Query extras'],
['start/api.tx.md', 'Transactions'],
['start/keyring.md', 'Keyring'],
['start/api.tx.subs.md', 'Transaction subscriptions'],
['start/api.tx.wrap.md', 'Complex transactions'],
['start/types.basics.md', 'Type basics'],
['start/types.extend.md', 'Type extension'],
['start/typescript.md', 'TypeScript interfaces']
]
},
{
title: 'Examples (Promise API)',
path: '/examples/promise/',
@@ -40,15 +64,15 @@ module.exports = {
]
},
{
title: 'Substrate interfaces',
title: 'Substrate defaults',
collapsable: false,
sidebarDepth: 0,
children: [
['/METHODS_RPC.md', 'Substrate RPC'],
['/METHODS_CONSTANTS.md', 'Constants (defaults)'],
['/METHODS_STORAGE.md', 'State storage (defaults)'],
['/METHODS_EXTRINSICS.md', 'Extrinsics (defaults)'],
['/METHODS_EVENTS.md', 'System events (defaults)']
['substrate/rpc.md', 'Substrate RPC'],
['substrate/constants.md', 'Constants'],
['substrate/storage.md', 'State storage'],
['substrate/extrinsics.md', 'Extrinsics'],
['substrate/events.md', 'System events']
]
},
['/api/', '@polkadot/api'],