1
0
mirror of https://github.com/fluencelabs/gitbook-docs synced 2025-06-18 17:31:28 +00:00

Draft documentation structure

This commit is contained in:
Pavel Murygin
2021-08-16 21:26:37 +03:00
parent 5afd345b6c
commit 968ea1ff85
8 changed files with 29 additions and 0 deletions

@ -15,6 +15,13 @@
* [Marine Rust SDK](knowledge_aquamarine/marine/marine-rs-sdk.md)
* [Tools](knowledge_tools.md)
* [Node](node.md)
* [JS SDK](js-sdk/readme.md)
* [Concepts?](js-sdk/1.md)
* [Using Aqua compiler with SDK?](js-sdk/2.md)
* [Running app in nodejs?](js-sdk/3.md)
* [Running app in browser?](js-sdk/4.md)
* [api reference?](js-sdk/5.md)
* [changelog?](js-sdk/changelog.md)
* [Security](knowledge_security.md)
* [Tutorials](tutorials_tutorials/README.md)
* [Setting Up Your Environment](tutorials_tutorials/recipes_setting_up.md)

8
js-sdk/1.md Normal file

@ -0,0 +1,8 @@
Table of contents
1. Description of the concept of Peer
2. Differences between js imlpementation and rust implementation
3. The lack of kademlia
4. The concept of relays
5. The connection between aqua ts compilation and JS SDK
6. High-level architecture (avm, particle queue etc)

7
js-sdk/2.md Normal file

@ -0,0 +1,7 @@
Table of contents
1. Basics of JS SDK: FluencePeer class, establishing connection
1. What is generated for functions
2. What is generated for services
3. Instance and global api, how the compiled code extends FluencePeer class
4. Glueing all the parts together

1
js-sdk/3.md Normal file

@ -0,0 +1 @@
Tutorial explaining how to write a simple app for node-js

1
js-sdk/4.md Normal file

@ -0,0 +1 @@
Tutorial explaining how to write a simple app for web (based on CRA)

3
js-sdk/5.md Normal file

@ -0,0 +1,3 @@
Table of content
1. Auto-generated docs from jsdoc comments created with typedoc

1
js-sdk/changelog.md Normal file

@ -0,0 +1 @@
Similar to what we have in aqua book

1
js-sdk/readme.md Normal file

@ -0,0 +1 @@
Some preface for the section