Skip to content

Commit

Permalink
fix build issues
Browse files Browse the repository at this point in the history
  • Loading branch information
lucas-tortora committed Feb 22, 2024
1 parent 9ed64a5 commit 7ba3174
Show file tree
Hide file tree
Showing 8 changed files with 158 additions and 10 deletions.
49 changes: 49 additions & 0 deletions docs/build/iota-sdk/2.0/docs/contribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
description: Contribute to the IOTA SDK joining the IOTA Libraries Initiative, contributing to the official GitHub repository or sharing your knowledge on Discord.
tags:
- join
- documentation
- project
- contribute
- discord
- GitHub
---

# Contribute to the IOTA SDK

If you're thinking about contributing to the IOTA SDK project, please consider the following ways to get involved.

## Join the IOTA Libraries Initiative

The [IOTA Libraries Initiative](https://github.com/iota-community/X-Team_IOTA_Libraries) is a collaborative effort aimed
at enhancing the developer experience. You can contribute in the following areas:

- Quality assurance and code review
- Documentation improvements
- Code sample creation

To get started, join the #experience channel on [Discord](https://discord.iota.org).

## Contribute to the Project's GitHub Repository

All of the project's code is open source and hosted on [GitHub](https://github.com/iotaledger/iota-sdk). You can contribute
in the following ways:

- Report any bugs you encounter
- Suggest new features or enhancements
- Contribute to the project's documentation

## Contribute to the Documentation

The project's documentation is also open source and available on GitHub. If you wish to contribute new documentation or
fix any errors, please refer to
the [contribution guidelines](https://github.com/iotaledger/iota-wiki/blob/main/.github/CONTRIBUTING.md).

## Share Your Knowledge

Helping others is a crucial aspect of any open source ecosystem. By sharing your knowledge with the community, you can
provide immense value and potentially inspire others to learn and contribute. Join the ongoing discussions in the
`#libraries` channel on [Discord](https://discord.iota.org).

Your contributions play a vital role in shaping and improving the project. We appreciate your interest and look forward
to your valuable contributions!
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
image: /img/banner/client_lib_overview.png
description: 'Learn how to connect to the Public Testnet API, explore the network using the Public Testnet Explorer, and obtain test tokens through the Public Testnet Faucet for testing value-based transactions.'
tags:
- Public Testnet
- API
- Public Testnet Explorer
- test tokens
- testnet network
- Testnet tokens
- Public Testnet Faucet
---

# Testnet and Test Tokens

## Connect to the Public Testnet

We recommend you start interacting via the Public Testnet network. The Public Testnet will allow you to safely get
acquainted with the IOTA SDK without the risk of losing any funds if you make a mistake along the way.

You can use this public load-balanced Public Testnet API:

```plaintext
https://api.testnet.shimmer.network
```

## Explore the Network

You can use the [Public Testnet Explorer](https://explorer.shimmer.network/testnet) to view transactions and data stored
in the Tangle.

## Get Test Tokens

You can get Testnet token using the [Public Testnet Faucet](https://faucet.testnet.shimmer.network).
You only need to input a valid Testnet address and the faucet will send you test tokens,
so you can safely develop your application without risking any capital.
4 changes: 2 additions & 2 deletions docs/build/iota-sdk/2.0/docs/getting-started/wasm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -110,10 +110,10 @@ npm install copy-webpack-plugin --save-dev

After you [installed the library](#install-the-iota-sdk), you can create a `Client` instance and interface with it.

The following example creates a [`Client`](../references/nodejs/classes/Client.md)
The following example creates a `Client`
instance connected to
the Shimmer Testnet, and retrieves the node's information by
calling [`Client.getInfo()`](../references/nodejs/classes/Client.md#getinfo),
calling `Client.getInfo()`,
and then print the node's information.

<Tabs groupId="usage" queryString>
Expand Down
24 changes: 24 additions & 0 deletions docs/build/iota-sdk/2.0/docs/how-tos/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
description: 'Explore the how-to guides in the IOTA SDK, offering step-by-step instructions on various topics and functionalities.'
image: /img/banner/client_lib_overview.png
tags:
- how-to guides
- instructions
- IOTA SDK
- code examples
---

# About How-to Guides

The IOTA SDK has several how-to guides that provide step-by-step instructions on various topics and functionalities. You
can use these guides to understand and implement specific tasks or features within your application. Whether you are a
beginner or an experienced developer, the how-to guides offer clear and concise explanations, making integrating IOTA
functionality into your projects easier.

To make the most of the how-to guides in the IOTA SDK, identify the specific topic or functionality you want to explore.
Whether generating addresses, sending transactions,
or minting NFTs, you can find dedicated guides that walk you through the process.

With the how-to guides in the IOTA SDK, you can overcome implementation hurdles and gain a deeper understanding
of the IOTA ecosystem. These guides empower you with the knowledge and practical examples to seamlessly integrate IOTA
functionality into your projects.
10 changes: 10 additions & 0 deletions docs/build/iota-sdk/2.0/docs/references/rust-api-reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Rust API Reference

The IOTA SDK Rust API Reference is in the [crate documentation](https://docs.rs/iota-sdk/latest/iota_sdk/).

Alternatively, you can generate docs for the whole crate by running the
following command:

```shell
cargo doc --document-private-items --no-deps --open
```
3 changes: 3 additions & 0 deletions docs/build/iota-sdk/2.0/docs/references/wasm-api-reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Wasm API Reference

Please refer to the [Node.js API reference](/iota-sdk/references/nodejs/api_ref/).
30 changes: 30 additions & 0 deletions docs/build/iota-sdk/2.0/docs/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
description: Troubleshooting the IOTA SDK.
tags:
- discussion
- channel
- problem
- solution
- discord
- stackexchange
---

# Troubleshooting

When you encounter a problem or need assistance while working with IOTA, there are several resources available to you.

## IOTA StackExchange

The [IOTA StackExchange](https://iota.stackexchange.com/) is a valuable tool for developers. There you can find many existing solutions and insights from the IOTA community.

## Discord Community

If you cannot find an immediate solution to your question, you may find help in the dedicated IOTA-SDK channel
within the official [IOTA Discord server](https://discord.iota.org). There you can engage with fellow developers and experts who can provide guidance and assistance.

## Joining the Discussion

If you wish to participate in broader discussions about the IOTA SDK or seek additional support, you can visit the
`#development` channel on the [IOTA Discord server](https://discord.iota.org). This channel serves as a hub for
discussions related to the IOTA client libraries, where you may interact with other developers and receive further
assistance.
12 changes: 4 additions & 8 deletions docs/build/iota-sdk/2.0/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -109,14 +109,10 @@ module.exports = {
},
],
},
/* {
{
type: 'category',
label: 'Explanations',
items: [
{
type: 'doc',
id: 'explanations/accounts-and-addresses',
},
{
type: 'doc',
id: 'explanations/testnet-and-test-tokens',
Expand All @@ -127,7 +123,7 @@ module.exports = {
type: 'category',
label: 'How To',
items: [
'how-tos/introduction',
'how-tos/introduction' /*
{
type: 'category',
label: 'Accounts and Addresses',
Expand Down Expand Up @@ -235,7 +231,7 @@ module.exports = {
},
],
},
'how-tos/exchange-guide',
'how-tos/exchange-guide',*/,
],
},
{
Expand Down Expand Up @@ -264,6 +260,6 @@ module.exports = {
type: 'doc',
id: 'contribute',
label: 'Contribute',
},*/
},
],
};

0 comments on commit 7ba3174

Please sign in to comment.