Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up SDK references in Book. #1133

Merged
merged 1 commit into from
Apr 3, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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)
Expand Down
3 changes: 3 additions & 0 deletions docs/src/frontend/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Application Frontend Development

- [TypeScript SDK](./typescript_sdk.md)
File renamed without changes.
6 changes: 0 additions & 6 deletions docs/src/sdks/index.md

This file was deleted.

14 changes: 0 additions & 14 deletions docs/src/sdks/rust-sdk.md

This file was deleted.

3 changes: 1 addition & 2 deletions docs/src/testing/index.md
Original file line number Diff line number Diff line change
@@ -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)
5 changes: 2 additions & 3 deletions docs/src/testing/testing-with-rust.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`).

Expand All @@ -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:

<!--TODO add test here once examples are tested-->
```rust,ignore
{{#include ../../../examples/hello_world/tests/harness.rs}}
```
Expand All @@ -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/).
3 changes: 0 additions & 3 deletions docs/src/testing/testing-with-typescript.md

This file was deleted.