Skip to content

Commit

Permalink
Apply some awesome changes (#45)
Browse files Browse the repository at this point in the history
- add embedded videos
- re estructure entry point and sdk section
  • Loading branch information
emmanuelm41 authored Aug 26, 2022
1 parent 96b8460 commit ea8044f
Show file tree
Hide file tree
Showing 13 changed files with 34 additions and 18 deletions.
5 changes: 5 additions & 0 deletions docs/client/client.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,8 @@ To create a new instance of that smart contract, you need the ABI and the CID yo
### Interact

To interact with it, you need the ABI and one of two paths: the CID you get when installing the smart contract, or the address of your smart contract instance.

## Tutorial

<iframe height="500" width="100%" src="https://www.youtube.com/embed/DlG5t5It7CE" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen/>
File renamed without changes.
19 changes: 19 additions & 0 deletions docs/fvm-as-sdk/fvm-as-sdk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: "FVM AssemblyScript SDK"
sidebar_position: 1
---
:::info The following project has been funded by the [Filecoin Foundation](https://fil.org).

<img src={require('../assets/fil_foundation.png').default} alt="drawing" width="300" />

:::

### What is AssemblyScript SDK?

The AssemblyScript SDK is the official SDK for writing FMV smart contracts using the AssemblyScript language.

### What is an SDK?

"A software development kit (SDK) is a set of tools provided by the manufacturer of (usually) a hardware platform, operating system (OS), or programming language.
SDKs help software developers create applications for that specific platform, system, or programming language. Think of it kind of like a toolkit, or the plastic bag of tools that comes packaged with the parts of a dresser you’ve bought to assemble yourself—only for app development. You have the building blocks—or development tools—you need to get the job done, and what’s included in the kit varies from manufacturer to manufacturer. "

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: How to build your own smart contracts?
sidebar_position: 3
sidebar_position: 4
---

### Where do I start?
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,6 @@
title: "Introduction"
sidebar_position: 1
---
:::info The following project has been funded by the [Filecoin Foundation](https://fil.org).

<img src={require('../assets/fil_foundation.png').default} alt="drawing" width="300" />

:::

### What is the Filecoin blockchain?
Filecoin is making the web more secure and efficient with a decentralized data storage marketplace, protocol, and cryptocurrency.
Expand All @@ -27,10 +22,3 @@ However, there are language-specific overheads that users need to be aware of (e
Rust is the primary language recommendation for writing efficient user-defined actors. Hence, the reference FVM SDK is built in Rust.

For more information, please refer to the FVM Specs [architecture web page](https://github.com/filecoin-project/fvm-specs/blob/main/01-architecture.md).

### What is AssemblyScript SDK?

"A software development kit (SDK) is a set of tools provided by the manufacturer of (usually) a hardware platform, operating system (OS), or programming language.
SDKs help software developers create applications for that specific platform, system, or programming language. Think of it kind of like a toolkit, or the plastic bag of tools that comes packaged with the parts of a dresser you’ve bought to assemble yourself—only for app development. You have the building blocks—or development tools—you need to get the job done, and what’s included in the kit varies from manufacturer to manufacturer. "

The AssemblyScript SDK is the official SDK for writing FMV smart contracts using the AssemblyScript language.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/sdk/local-fvm.md → docs/fvm-as-sdk/local-fvm.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Using integration test module to test your actor in FVM"
sidebar_position: 5
sidebar_position: 6
---

To help testing your application without deploying a node you can use the rust (Integration test module)[https://github.com/filecoin-project/ref-fvm/tree/master/testing/integration]. It requires to have Rust 🦀 and be a bit familiar with it.
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/run-it.md → docs/fvm-as-sdk/run-it.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: How to run it?
sidebar_position: 4
sidebar_position: 5
---

First, you need to install your smart contract on the FVM. Once you have done it, you need to create an instance of it. You can create as many instances as you want. Each one will
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/structure.md → docs/fvm-as-sdk/structure.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Project Structure"
sidebar_position: 1
sidebar_position: 2
---

### Env
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/test-it.md → docs/fvm-as-sdk/test-it.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: How to test it in CI?
sidebar_position: 6
sidebar_position: 7
---

In order to test your smart contracts, today we have two different options. You can choose either a local VM written on Rust or using a full filecoin dev node.
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/use-it.md → docs/fvm-as-sdk/use-it.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "How to use it?"
sidebar_position: 2
sidebar_position: 3
---

### Install deps
Expand Down
4 changes: 4 additions & 0 deletions docs/start-coding/new_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ It will make things super easy for you, as everything you need is already there.
You can either fork the repo or copy the code and create a new repo.
[Let's go to the template repo](https://github.com/Zondax/fil-template-actor-as) :arrow_upper_right:

<iframe height="500" width="100%" src="https://www.youtube.com/embed/8NjOzj8DyZg" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen/>
### From scratch
You can create a new project by running the following lines:
```
Expand Down

0 comments on commit ea8044f

Please sign in to comment.