diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 99232da937b..39370d86e95 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -12,9 +12,6 @@ - [Subcurrency](./examples/subcurrency.md) - [FizzBuzz](./examples/fizzbuzz.md) - [Wallet Smart Contract](./examples/wallet_smart_contract.md) -- [SDK](./sdks/index.md) - - [Rust SDK](./sdks/rust-sdk.md) - - [TypeScript SDK](./sdks/typescript-sdk.md) - [Program Types](./sway-program-types/index.md) - [Contracts](./sway-program-types/smart_contracts.md) - [Libraries](./sway-program-types/libraries.md) @@ -36,12 +33,13 @@ - [Native Assets](./blockchain-development/native_assets.md) - [Testing](./testing/index.md) - [Testing with Rust](./testing/testing-with-rust.md) - - [Testing with TypeScript](./testing/testing-with-typescript.md) - [Advanced Concepts](./advanced/index.md) - [Generic Types](./advanced/generic_types.md) - [Traits](./advanced/traits.md) - [Trait Constraints](./advanced/trait_constraints.md) - [Assembly](./advanced/assembly.md) +- [Application Frontend](./frontend/index.md) + - [TypeScript SDK](./frontend/typescript_sdk.md) - [Reference](./reference/index.md) - [Style Guide](./reference/style_guide.md) - [Temporary Workarounds](./reference/temporary_workarounds.md) diff --git a/docs/src/frontend/index.md b/docs/src/frontend/index.md new file mode 100644 index 00000000000..6a303182bae --- /dev/null +++ b/docs/src/frontend/index.md @@ -0,0 +1,3 @@ +# Application Frontend Development + +- [TypeScript SDK](./typescript_sdk.md) diff --git a/docs/src/sdks/typescript-sdk.md b/docs/src/frontend/typescript_sdk.md similarity index 100% rename from docs/src/sdks/typescript-sdk.md rename to docs/src/frontend/typescript_sdk.md diff --git a/docs/src/sdks/index.md b/docs/src/sdks/index.md deleted file mode 100644 index 59e010a47c9..00000000000 --- a/docs/src/sdks/index.md +++ /dev/null @@ -1,6 +0,0 @@ -# SDK - -We currently provide SDK's for Rust and TypeScript. - -- [Rust SDK](./rust-sdk.md) -- [TypeScript SDK](./typescript-sdk.md) diff --git a/docs/src/sdks/rust-sdk.md b/docs/src/sdks/rust-sdk.md deleted file mode 100644 index ea22dd4fe24..00000000000 --- a/docs/src/sdks/rust-sdk.md +++ /dev/null @@ -1,14 +0,0 @@ -# Rust SDK - -The Rust SDK supports common tasks like: - -- Programmatically compiling Sway code -- Launching Fuel nodes -- Deploying contracts -- Interacting with deployed contracts -- Running Sway scripts -- Generating Type-safe Sway contract bindings -- CLI for common operations -- [Testing](../testing/testing-with-rust.md) - -Refer [here](https://github.com/FuelLabs/fuels-rs) for full documentation. diff --git a/docs/src/testing/index.md b/docs/src/testing/index.md index 980b5efe7e6..fb2ccd24bb7 100644 --- a/docs/src/testing/index.md +++ b/docs/src/testing/index.md @@ -1,6 +1,5 @@ # Testing -There are a couple options for testing your Sway contract: +Testing your Sway contracts can be done with the Rust SDK. - [Testing with Rust](./testing-with-rust.md) -- [Testing with TypeScript](./testing-with-typescript.md) diff --git a/docs/src/testing/testing-with-rust.md b/docs/src/testing/testing-with-rust.md index 3eb3ae287ce..fb59d66664c 100644 --- a/docs/src/testing/testing-with-rust.md +++ b/docs/src/testing/testing-with-rust.md @@ -14,7 +14,7 @@ $ tree . └── harness.rs ``` -Note that this is also a Rust package, hence the existence of a `Cargo.toml` (Rust manifest file) in the project root directory. The `Cargo.toml` in the root directory contains necessary Rust dependencies to enable you to write Rust-based tests using our [Rust SDK](https://github.com/FuelLabs/fuels-rs) (`fuels-rs`). +Note that this is also a Rust package, hence the existence of a `Cargo.toml` (Rust manifest file) in the project root directory. The `Cargo.toml` in the root directory contains necessary Rust dependencies to enable you to write Rust-based tests using our [Rust SDK](https://github.com/FuelLabs/fuels-rs), (`fuels-rs`). These tests can be run using `forc test` which will look for Rust tests under the `tests/` directory (created automatically with `forc init`). @@ -26,6 +26,7 @@ For example, let's write tests against the following contract, written in Sway. Our `tests/harness.rs` file could look like: + ```rust,ignore {{#include ../../../examples/hello_world/tests/harness.rs}} ``` @@ -40,5 +41,3 @@ test harness ... ok test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.64s ``` - -Instead of writing tests in Rust, tests can also be written in TypeScript using our [TypeScript SDK](https://github.com/FuelLabs/fuels-ts/). diff --git a/docs/src/testing/testing-with-typescript.md b/docs/src/testing/testing-with-typescript.md deleted file mode 100644 index a77b0cbe65c..00000000000 --- a/docs/src/testing/testing-with-typescript.md +++ /dev/null @@ -1,3 +0,0 @@ -# Testing with TypeScript - -Tests can also be written in TypeScript using our [TypeScript SDK](https://github.com/FuelLabs/fuels-ts/).