From 968ea1ff85657018d9291952212530ecfb436e34 Mon Sep 17 00:00:00 2001 From: Pavel Murygin Date: Mon, 16 Aug 2021 21:26:37 +0300 Subject: [PATCH] Draft documentation structure --- SUMMARY.md | 7 +++++++ js-sdk/1.md | 8 ++++++++ js-sdk/2.md | 7 +++++++ js-sdk/3.md | 1 + js-sdk/4.md | 1 + js-sdk/5.md | 3 +++ js-sdk/changelog.md | 1 + js-sdk/readme.md | 1 + 8 files changed, 29 insertions(+) create mode 100644 js-sdk/1.md create mode 100644 js-sdk/2.md create mode 100644 js-sdk/3.md create mode 100644 js-sdk/4.md create mode 100644 js-sdk/5.md create mode 100644 js-sdk/changelog.md create mode 100644 js-sdk/readme.md diff --git a/SUMMARY.md b/SUMMARY.md index 9e439f7..cb1c970 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -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) diff --git a/js-sdk/1.md b/js-sdk/1.md new file mode 100644 index 0000000..a689cc3 --- /dev/null +++ b/js-sdk/1.md @@ -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) \ No newline at end of file diff --git a/js-sdk/2.md b/js-sdk/2.md new file mode 100644 index 0000000..acd564e --- /dev/null +++ b/js-sdk/2.md @@ -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 \ No newline at end of file diff --git a/js-sdk/3.md b/js-sdk/3.md new file mode 100644 index 0000000..432fc09 --- /dev/null +++ b/js-sdk/3.md @@ -0,0 +1 @@ +Tutorial explaining how to write a simple app for node-js \ No newline at end of file diff --git a/js-sdk/4.md b/js-sdk/4.md new file mode 100644 index 0000000..ed3c070 --- /dev/null +++ b/js-sdk/4.md @@ -0,0 +1 @@ +Tutorial explaining how to write a simple app for web (based on CRA) \ No newline at end of file diff --git a/js-sdk/5.md b/js-sdk/5.md new file mode 100644 index 0000000..5f16ff3 --- /dev/null +++ b/js-sdk/5.md @@ -0,0 +1,3 @@ +Table of content + +1. Auto-generated docs from jsdoc comments created with typedoc diff --git a/js-sdk/changelog.md b/js-sdk/changelog.md new file mode 100644 index 0000000..713ac03 --- /dev/null +++ b/js-sdk/changelog.md @@ -0,0 +1 @@ +Similar to what we have in aqua book \ No newline at end of file diff --git a/js-sdk/readme.md b/js-sdk/readme.md new file mode 100644 index 0000000..d3dc019 --- /dev/null +++ b/js-sdk/readme.md @@ -0,0 +1 @@ +Some preface for the section \ No newline at end of file