feat: initial documentation for Logos Storage#166
Conversation
| @@ -0,0 +1,238 @@ | |||
| # Getting Started with libstorage | |||
|
|
|||
| In this tutorial, we will build a simple [libstorage-based](https://github.com/logos-storage/logos-storage-nim) C application which allows sharing files over the Logos Storage network. Since libstorage is a low-level API and its main use case are library and not application developers, however, we will use a higher-level C wrapper developed for this tutorial which we refer to as [easylibstorage](https://github.com/logos-storage/easylibstorage). | |||
There was a problem hiding this comment.
| In this tutorial, we will build a simple [libstorage-based](https://github.com/logos-storage/logos-storage-nim) C application which allows sharing files over the Logos Storage network. Since libstorage is a low-level API and its main use case are library and not application developers, however, we will use a higher-level C wrapper developed for this tutorial which we refer to as [easylibstorage](https://github.com/logos-storage/easylibstorage). | |
| In this tutorial, we will build a simple [libstorage-based](https://github.com/logos-storage/logos-storage-nim) C application which allows sharing files over the Logos Storage network. Since libstorage is a low-level API, its main use case is to be used as a library and wrapped into a higher-level abstraction. As such, we will use a higher-level C wrapper developed for this tutorial called [easylibstorage](https://github.com/logos-storage/easylibstorage). |
README Co-authored-by: Sasha <118575614+weboko@users.noreply.github.com>
|
@kashepavadan should I give it another review? |
Yes please |
| @@ -0,0 +1,210 @@ | |||
| --- | |||
There was a problem hiding this comment.
this file is called libstorage-tutorial.md which is not correct anymore
| authors: | ||
| owner: logos | ||
| doc_version: 1 | ||
| slug: libstorage-tutorial |
There was a problem hiding this comment.
nit: this too seems better to rename
|
Cross-checked the tutorial against Divergences
Naming inflation (cross-cutting, but most visible here)The PR uses Logos Storage / Logos Storage Module / libstorage / logos-storage-nim / easylibstorage in close proximity. The UI consistently uses cc @gmega |
This PR adds:
This will be complemented by the Logos Storage UI app and its documentation.
Doc Packet info:
A. Outcome + value (required)
Outcome (end goal): They'll have an idea of what's possible to do with Logos Storage; i.e., publish and share files. They'll also have an overview of what
libstorageenables, and of its flows (albeit in a simplified manner).Why it matters: the journey summarises the main use cases for Logos Storage in v0.1: create / download / delete / retrieve files using Logos Storage.
B. Scope + ownership
Journey name: Use the Logos Storage module API (create / download / delete / retrieve) to manage files on a local storage-enabled node (though this is not the Logos Storage module API yet, it's libstorage).
Owner (GitHub + Discord): @gmega
Applies to: https://github.com/logos-storage/easylibstorage, commit
36b0242.Runtime target: local (could be easily modified to run on the Logos testnet v0.1).
C. Runnable happy path
The tutorial describes all of this.
D. Configuration
Again, all described in the tutorial.
E. Hardware requirements (required for node/client journeys)
Should work on any x86_64 or arm64 computer. Needs minimal RAM (e.g. 4GB), minimal disk space (e.g. 100 MB).
F. Verify + troubleshoot
Included in the tutorial.
G. Limits for v0.1
None to report (for now).
H. References
None yet, will probably put together architecture docs over time but those are not there yet.
Optional (only if you can)