Skip to content

Commit

Permalink
rename docs collection to match gh-pages base
Browse files Browse the repository at this point in the history
  • Loading branch information
rakeden committed Dec 8, 2021
1 parent 6cb218f commit 024fb2a
Show file tree
Hide file tree
Showing 59 changed files with 94 additions and 94 deletions.
4 changes: 2 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ email: [email protected]
layout: default
The hub for blockchain development tutorials, quickstart guides, API documentation, and more.
Everything you need to learn blockchain programming, blockchain dApp development on WAX, or duplicate an EOS dApp.
baseurl: "/wax-docs" # the subpath of your site, e.g. /blog
url: "https://wax-office-of-inspector-general.github.io/wax-developer" # the base hostname & protocol for your site, e.g. http://example.com
baseurl: "/wax-developer" # the subpath of your site, e.g. /blog
url: "https://wax-office-of-inspector-general.github.io" # the base hostname & protocol for your site, e.g. http://example.com

# socials
twitter_username: WAX_io
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ layout: default
parent: WAX-RPC API Reference
---

All of your smart contracts inherit from the C++ API files available in the [WAX Contract Development Toolkit (WAX-CDT)](/wax-docs/dev-docs/cdt) library. These files are used to define your smart contract's actions, structures, and data types.
All of your smart contracts inherit from the C++ API files available in the [WAX Contract Development Toolkit (WAX-CDT)](/wax-developer/docs/cdt) library. These files are used to define your smart contract's actions, structures, and data types.

This smart contract API can be grouped into three key modules:

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -23,22 +23,22 @@ WAX is fully compatible with EOS smart contracts and offers free blockchain acco

<a href="https://all-access.wax.io" target="_blank">http://<span></span>all-access.wax.io</a>

A WAX Cloud Wallet Account automatically creates a WAX Blockchain account for your customers and allows you to integrate WaxJS into your dApps. Refer to [WAX Cloud Wallet Quickstart](/wax-docs/dev-docs/waa_waxjs_qstart) for more information.
A WAX Cloud Wallet Account automatically creates a WAX Blockchain account for your customers and allows you to integrate WaxJS into your dApps. Refer to [WAX Cloud Wallet Quickstart](/wax-developer/docs/waa_waxjs_qstart) for more information.

## Development Environment

If you'd like to test your smart contracts on WAX, you can:

* Complete our [Docker Quickstart](/wax-docs/dev-docs/docker_qstart) (recommended) or use the [WAX Blockchain Setup](/wax-docs/dev-docs/blockchain_setup) to build from source.
* Build your contracts using the [WAX Contract Development Toolkit (WAX-CDT)](/wax-docs/dev-docs/cdt).
* [Set Up a Local dApp Environment](/wax-docs/dev-docs/local_dapp_dev).
* Deploy to the [WAX Testnet](/wax-docs/dev-docs/testnet_depoy).
* Complete our [Docker Quickstart](/wax-developer/docs/docker_qstart) (recommended) or use the [WAX Blockchain Setup](/wax-developer/docs/blockchain_setup) to build from source.
* Build your contracts using the [WAX Contract Development Toolkit (WAX-CDT)](/wax-developer/docs/cdt).
* [Set Up a Local dApp Environment](/wax-developer/docs/local_dapp_dev).
* Deploy to the [WAX Testnet](/wax-developer/docs/testnet_depoy).

<strong>Warning:</strong> Setting up WAX source code in your local development environment will overwrite a current EOS installation. If you'd like to keep your EOS environment, it's recommended that you use Docker, a virtual machine, or a separate development environment.
{: .label .label-yellow }

## Deploy Your Smart Contracts

You must compile your smart contracts using the [WAX Contract Development Toolkit (WAX-CDT)](/wax-docs/dev-docs/cdt).
You must compile your smart contracts using the [WAX Contract Development Toolkit (WAX-CDT)](/wax-developer/docs/cdt).

If you don't want to install the WAX source code, you can use our [Docker Quickstart](/wax-docs/dev-docs/docker_qstart) or custom scripts to deploy your smart contracts. Refer to [Deploy Your dApp on WAX](/wax-docs/dev-docs/dapp_deploy) for more information.
If you don't want to install the WAX source code, you can use our [Docker Quickstart](/wax-developer/docs/docker_qstart) or custom scripts to deploy your smart contracts. Refer to [Deploy Your dApp on WAX](/wax-developer/docs/dapp_deploy) for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,17 @@ Below you'll find WAX versions, URLs, and development environment information.
<tbody>
<tr>
<td><a href="https://hub.docker.com/u/waxteam" target="_blank">Docker Images</a></td>
<td>Use WAX Docker images to run a local node, use blockchain tools, and compile your smart contracts. Refer to [Docker Quickstart](/wax-docs/dev-docs/docker_qstart) for more information.</td>
<td>Use WAX Docker images to run a local node, use blockchain tools, and compile your smart contracts. Refer to [Docker Quickstart](/wax-developer/docs/docker_qstart) for more information.</td>
</tr>
<tr><td><a href="https://github.com/worldwide-asset-exchange/waxjs" target="_blank">waxjs</a></td>
<td>WaxJS Javascript API for integration with the WAX Cloud Wallet. Use this to easily sign in users and send transactions to the WAX Blockchain from your dApp. Refer to [WAX Cloud Wallet Quickstart](/wax-docs/dev-docs/waa_waxjs_qstart) for more information.</td>
<td>WaxJS Javascript API for integration with the WAX Cloud Wallet. Use this to easily sign in users and send transactions to the WAX Blockchain from your dApp. Refer to [WAX Cloud Wallet Quickstart](/wax-developer/docs/waa_waxjs_qstart) for more information.</td>
</tr>
<tr>
<td><a href="https://github.com/worldwide-asset-exchange/wax-blockchain" target="_blank">wax-blockchain</a></td><td>WAX Blockchain source files. Refer to [WAX Blockchain Setup](/wax-docs/dev-docs/blockchain_setup) to get started.</td>
<td><a href="https://github.com/worldwide-asset-exchange/wax-blockchain" target="_blank">wax-blockchain</a></td><td>WAX Blockchain source files. Refer to [WAX Blockchain Setup](/wax-developer/docs/blockchain_setup) to get started.</td>
</tr>
<tr>
<td><a href="https://github.com/worldwide-asset-exchange/wax-cdt" target="_blank">wax-cdt</a></td>
<td>WAX Contract Development Toolkit. Refer to [WAX Contract Development Toolkit (WAX-CDT)](/wax-docs/dev-docs/cdt) to get started.</td>
<td>WAX Contract Development Toolkit. Refer to [WAX Contract Development Toolkit (WAX-CDT)](/wax-developer/docs/cdt) to get started.</td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -130,7 +130,7 @@ Below you'll find WAX versions, URLs, and development environment information.

## WAX Local Testnet

When you [Set Up a Local dApp Environment](/wax-docs/dev-docs/local_dapp_dev), you can make calls to your local API using the following URL.
When you [Set Up a Local dApp Environment](/wax-developer/docs/local_dapp_dev), you can make calls to your local API using the following URL.

<table>
<thead>
Expand All @@ -154,20 +154,20 @@ When you [Set Up a Local dApp Environment](/wax-docs/dev-docs/local_dapp_dev), y

You can write WAX smart contracts using the C++ programming language. No custom language is required, although you'll need to familiarize yourself with the WAX C/C++ API library. This library contains the core files required to communicate with the WAX Blockchain. When you're ready to get started, refer to:

* [WAX Contract Development Toolkit (WAX-CDT)](/wax-docs/dev-docs/cdt)
* [WAX-CDT API](/wax-docs/dev-docs/cdt_api)
* [Smart Contract Basics](/wax-docs/dev-docs/smart_contract_basics)
* [WAX Contract Development Toolkit (WAX-CDT)](/wax-developer/docs/cdt)
* [WAX-CDT API](/wax-developer/docs/cdt_api)
* [Smart Contract Basics](/wax-developer/docs/smart_contract_basics)

<!--The [WAX Contract Development Toolkit (WAX-CDT)](/wax-docs/dev-docs/cdt) includes everything you need to create and compile all of your smart contracts.-->
<!--The [WAX Contract Development Toolkit (WAX-CDT)](/wax-developer/docs/cdt) includes everything you need to create and compile all of your smart contracts.-->

## Development Tools

You can use any third party C++ editor or IDE to write your smart contracts, such as Sublime Text, Atom, CLion, Eclipse, or Visual Studio products.

<a href="https://www.eosstudio.io/" target="_blank">EOS Studio</a> is a graphic IDE built for EOSIO dApp development, available on Linux, Mac OS, and Windows. This tool features a code editor, contract inspector, and a network manager. To integrate WAX with EOS Studio, refer to <a href="https://github.com/worldwide-asset-exchange/wax-blockchain/tree/develop/samples/eos-studio" target="_blank">How to use EOS Studio with WAX</a>. Our script provides a minimal integration, developed and tested with Ubuntu 18.04.

<a href="https://github.com/EOSIO/eosjs" target="_blank">eosjs</a> is a javascript API SDK you can use to easily communicate with the WAX Blockchain API. Refer to [WAX RPC API](/wax-docs/dev-docs/blockchain_api) for more information.
<a href="https://github.com/EOSIO/eosjs" target="_blank">eosjs</a> is a javascript API SDK you can use to easily communicate with the WAX Blockchain API. Refer to [WAX RPC API](/wax-developer/docs/blockchain_api) for more information.

<a href="https://www.dfuse.io" target="_blank">dfuse</a> is a powerful suite of APIs that allow you to query the WAX Blockchain and stream real-time data. Refer to [dfuse for WAX dApps](/wax-docs/dev-docs/dfuse_overview) for more information.
<a href="https://www.dfuse.io" target="_blank">dfuse</a> is a powerful suite of APIs that allow you to query the WAX Blockchain and stream real-time data. Refer to [dfuse for WAX dApps](/wax-developer/docs/dfuse_overview) for more information.


Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ In this guide, you'll learn how to customize the **hello-world** build scripts t
Before you begin:

* Make sure Docker is configured to run without sudo.
* Download the <a href="https://github.com/worldwide-asset-exchange/wax-blockchain" target="_blank">WAX Blockchain Source Code</a>. Refer to the [WAX Blockchain Setup](/wax-docs/dev-docs/blockchain_setup) for more information.
* Download the <a href="https://github.com/worldwide-asset-exchange/wax-blockchain" target="_blank">WAX Blockchain Source Code</a>. Refer to the [WAX Blockchain Setup](/wax-developer/docs/blockchain_setup) for more information.
* Have your WAX Blockchain Account public/private keys available.
* Make sure you have enough WAX staked in your account to allocate resources.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ grand_parent: dApp Development

In this guide, you'll use the <span class="codeSample">cleos set contract</span> command to deploy your smart contract to the WAX mainnet.

Before you begin, you'll need to compile your smart contract and have your WASM and ABI files ready. Refer to [Smart Contract Quickstart](/wax-docs/dev-docs/dapp_build) or [WAX-CDT Build Tools](/wax-docs/dev-docs/cdt_cpp) for more information.
Before you begin, you'll need to compile your smart contract and have your WASM and ABI files ready. Refer to [Smart Contract Quickstart](/wax-developer/docs/dapp_build) or [WAX-CDT Build Tools](/wax-developer/docs/cdt_cpp) for more information.

You'll also need to:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ parent: dApp Development
has_children: true
---

To deploy your dApp on WAX, you'll need to use [WAX-CDT](/wax-docs/dev-docs/cdt) and [Blockchain Tools](/wax-docs/dev-docs/blockchain_tools) to:
To deploy your dApp on WAX, you'll need to use [WAX-CDT](/wax-developer/docs/cdt) and [Blockchain Tools](/wax-developer/docs/blockchain_tools) to:

* Compile your smart contracts
* Create WAX Blockchain Accounts for each of your contracts
Expand Down Expand Up @@ -45,16 +45,16 @@ If you prefer, you can deploy your smart contracts from the command line using W

### Advantages

* Allows more control over the build process and deployment parameters. Refer to [WAX-CDT Options](/wax-docs/dev-docs/cdt_options) for more information.
* If you used **eosio-init** to [Create a Smart Contract](/wax-docs/dev-docs/dapp_hello_world) and deploy to your local blockchain, this might be a good option for you.
* Allows more control over the build process and deployment parameters. Refer to [WAX-CDT Options](/wax-developer/docs/cdt_options) for more information.
* If you used **eosio-init** to [Create a Smart Contract](/wax-developer/docs/dapp_hello_world) and deploy to your local blockchain, this might be a good option for you.
* Compatible for Windows users.

### What You'll Need

To use this option, you'll need to:

* Complete our [Docker Quickstart](/wax-docs/dev-docs/docker_qstart) (recommended) or use the [WAX Blockchain Setup](/wax-docs/dev-docs/blockchain_setup) to build from source.
* Use the [WAX Contract Development Toolkit (WAX-CDT)](/wax-docs/dev-docs/cdt) to compile your smart contracts.
* Complete our [Docker Quickstart](/wax-developer/docs/docker_qstart) (recommended) or use the [WAX Blockchain Setup](/wax-developer/docs/blockchain_setup) to build from source.
* Use the [WAX Contract Development Toolkit (WAX-CDT)](/wax-developer/docs/cdt) to compile your smart contracts.

## Before You Begin

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ To re-start your container, use the <span class="codeSample">docker start</span>
docker start waxdev
```

Now that you've set up your Docker environment, you're ready to follow the guides in this section. While it's not required to complete the [WAX Blockchain Setup](/wax-docs/dev-docs/blockchain_setup) in the next tutorial, we still recommend downloading the source code to access code samples and **make** scripts.
Now that you've set up your Docker environment, you're ready to follow the guides in this section. While it's not required to complete the [WAX Blockchain Setup](/wax-developer/docs/blockchain_setup) in the next tutorial, we still recommend downloading the source code to access code samples and **make** scripts.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The console prints:
bin boot dev etc home lib lib32 lib64 media mnt opt proc root run sbin srv sys tmp usr var wax
```

The list above includes the **wax** directory that you shared when you started your **waxdev** container. You can <span class="codeSample">cd</span> into this directory when you're ready to [Create a Smart Contract](/wax-docs/dev-docs/dapp_hello_world).
The list above includes the **wax** directory that you shared when you started your **waxdev** container. You can <span class="codeSample">cd</span> into this directory when you're ready to [Create a Smart Contract](/wax-developer/docs/dapp_hello_world).

<strong>Tip:</strong> Sharing your local host's folder with your waxdev Docker container allows you to create directories that exist on both your host and the docker container. This makes it easy to build and deploy your smart contracts using Docker.
{: .label .label-yellow }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Using our Docker environment offers the following benefits:

* Adds convenience and speed to your development efforts
* Eliminates the need to manage source code
* Eliminates the need to meet our [Supported Operating Systems](/wax-docs/dev-docs/os) requirements
* Eliminates the need to meet our [Supported Operating Systems](/wax-developer/docs/os) requirements
* Doesn't overwrite an existing installation of EOSIO
* Makes it easy to upgrade and try out new features
* Makes it easy to switch between production and development environments
Expand All @@ -37,12 +37,12 @@ Below is a list of our core Docker images. For a complete list, refer to <a href
<tbody>
<tr>
<td><a href="https://hub.docker.com/r/waxteam/dev" target="_blank">waxteam/dev</a></td>
<td>This <strong>development</strong> image includes everything you need to get the WAX Blockchain up and running. You can use this image to run a WAX node, create a local development environment, and create and compile smart contracts using the [WAX Contract Development Toolkit (WAX-CDT)](/wax-docs/dev-docs/cdt).</td>
<td>This <strong>development</strong> image includes everything you need to get the WAX Blockchain up and running. You can use this image to run a WAX node, create a local development environment, and create and compile smart contracts using the [WAX Contract Development Toolkit (WAX-CDT)](/wax-developer/docs/cdt).</td>
</tr>

<tr>
<td><a href="https://hub.docker.com/r/waxteam/cdt" target="_blank">waxteam/cdt</a></td>
<td>Use this image to create and compile smart contracts using the [WAX Contract Development Toolkit (WAX-CDT)](/wax-docs/dev-docs/cdt). This image does <strong>not</strong> allow you to run a WAX node or use [Blockchain Tools](/wax-docs/dev-docs/blockchain_tools).</td>
<td>Use this image to create and compile smart contracts using the [WAX Contract Development Toolkit (WAX-CDT)](/wax-developer/docs/cdt). This image does <strong>not</strong> allow you to run a WAX node or use [Blockchain Tools](/wax-developer/docs/blockchain_tools).</td>
</tr>

<tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,23 @@ has_toc: true

You can use the following guides to set up your WAX dApp development environment:

* Complete our [Docker Quickstart](/wax-docs/dev-docs/docker_qstart)
* Download WAX Blockchain source code and samples using the [WAX Blockchain Setup](/wax-docs/dev-docs/blockchain_setup) guide
* Learn about the [WAX Contract Development Toolkit (WAX-CDT)](/wax-docs/dev-docs/cdt)
* [Set Up a Local dApp Environment](/wax-docs/dev-docs/local_dapp_dev)
* Complete our [Docker Quickstart](/wax-developer/docs/docker_qstart)
* Download WAX Blockchain source code and samples using the [WAX Blockchain Setup](/wax-developer/docs/blockchain_setup) guide
* Learn about the [WAX Contract Development Toolkit (WAX-CDT)](/wax-developer/docs/cdt)
* [Set Up a Local dApp Environment](/wax-developer/docs/local_dapp_dev)

<span class="anchor" id="buildDapp"></span>
<h2>Build a dApp</h2>

Once you've set up your development environment, these tutorials can help you launch the next great dApp on WAX:

* [Smart Contract Quickstart](/wax-docs/dev-docs/dapp_build)
* [Deploy Your dApp on WAX](/wax-docs/dev-docs/dapp_deploy)
* [Smart Contract Quickstart](/wax-developer/docs/dapp_build)
* [Deploy Your dApp on WAX](/wax-developer/docs/dapp_deploy)

<span class="anchor" id="guides"></span>
<h2>Guides</h2>

Learn how to make API requests to your local blockchain and the WAX mainnet, and get an overview of the WAX-CDT C++ API used to build your smart contracts.

* [WAX RPC API](/wax-docs/dev-docs/blockchain_api)
* [WAX-CDT API](/wax-docs/dev-docs/cdt_api)
* [WAX RPC API](/wax-developer/docs/blockchain_api)
* [WAX-CDT API](/wax-developer/docs/cdt_api)
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ curl: (7) Failed to connect to 127.0.0.1 port 8888: Connection refused

## Additional Information

Refer to [WAX RPC API](/wax-docs/dev-docs/blockchain_api) for more information.
Refer to [WAX RPC API](/wax-developer/docs/blockchain_api) for more information.
Loading

0 comments on commit 024fb2a

Please sign in to comment.