diff --git a/src/pages/en/index.md b/src/pages/en/index.md index 066d3437..00276262 100644 --- a/src/pages/en/index.md +++ b/src/pages/en/index.md @@ -3,8 +3,6 @@ title: Stacks documentation description: Learn about Stacks mining, the STX token, and the Clarity smart contract language --- --> Content related to developer tools and app development has recently moved to [docs.hiro.so](https://docs.hiro.so/). For more information on the content move, see [this post](https://forum.stacks.org/t/the-evolution-of-the-stacks-documentation-and-a-new-hiro-docs-site/12343) on the Stacks forum. - ## Understand Stacks [@page-reference | grid] @@ -13,9 +11,16 @@ description: Learn about Stacks mining, the STX token, and the Clarity smart con ## Write smart contracts [@page-reference | grid] -| /write-smart-contracts/overview, /write-smart-contracts/tokens +| /write-smart-contracts/overview, /write-smart-contracts/tokens, /write-smart-contracts/language-functions -## Start mining +## Run nodes and miners [@page-reference | grid] -| /start-mining/mainnet, /start-mining/testnet +| /nodes-and-miners/running-mainnet-node, /nodes-and-miners/running-testnet-node, /nodes-and-miners/miner-mainnet, /nodes-and-miners/miner-testnet + +## GAIA and more + +[@page-reference | grid] +| /gaia/overview, /references/glossary + +-> Content related to developer tools and app development has recently moved to [docs.hiro.so](https://docs.hiro.so/). For more information on the content move, see [this post](https://forum.stacks.org/t/the-evolution-of-the-stacks-documentation-and-a-new-hiro-docs-site/12343) on the Stacks forum. diff --git a/src/pages/en/nodes-and-miners/running-mainnet-node.md b/src/pages/en/nodes-and-miners/running-mainnet-node.md index 679d5b0f..5ae89717 100644 --- a/src/pages/en/nodes-and-miners/running-mainnet-node.md +++ b/src/pages/en/nodes-and-miners/running-mainnet-node.md @@ -15,14 +15,11 @@ images: This procedure demonstrates how to run a local mainnet node using Docker images. --> This procedure focuses on Unix-like operating systems (Linux and MacOS). This procedure has not been tested on -Windows. +-> This procedure focuses on Unix-like operating systems (Linux and MacOS). This procedure has not been tested on Windows. ## Prerequisites -Running a node has no specialized hardware requirements. Users have been successful in running nodes on Raspberry Pi -boards and other system-on-chip architectures. In order to complete this procedure, you must have the following software -installed on the node host machine: +Running a node has no specialized hardware requirements. Users have been successful in running nodes on Raspberry Pi boards and other system-on-chip architectures. In order to complete this procedure, you must have the following software installed on the node host machine: - [Docker](https://docs.docker.com/get-docker/) - [curl](https://curl.se/download.html) @@ -30,9 +27,7 @@ installed on the node host machine: ### Firewall configuration -In order for the API node services to work correctly, you must configure any network firewall rules to allow traffic on -the ports discussed in this section. The details of network and firewall configuration are highly specific to your -machine and network, so a detailed example isn't provided. +In order for the API node services to work correctly, you must configure any network firewall rules to allow traffic on the ports discussed in this section. The details of network and firewall configuration are highly specific to your machine and network, so a detailed example isn't provided. The following ports must open on the host machine: @@ -52,8 +47,7 @@ These egress ports are for syncing [`stacks-blockchain`][] and Bitcoin headers. ## Step 1: initial setup -In order to run the mainnet node, you must download the Docker images and create a directory structure to hold the -persistent data from the services. Download and configure the Docker images with the following commands: +In order to run the mainnet node, you must download the Docker images and create a directory structure to hold the persistent data from the services. Download and configure the Docker images with the following commands: ```sh docker pull blockstack/stacks-blockchain @@ -67,8 +61,7 @@ mkdir -p ./stacks-node/{persistent-data/stacks-blockchain/mainnet,config/mainnet ## Step 2: running Stacks blockchain -First, create the `./config/mainnet/Config.toml` file and add the following content to the -file using a text editor: +First, create the `./config/mainnet/Config.toml` file and add the following content to the file using a text editor: ```toml [node] @@ -189,7 +182,5 @@ The rpc configuration of your bitcoin node is out of the scope of this document, ## Additional reading -- [Running an API instance with Docker][] - [running a testnet node with docker]: /understand-stacks/running-testnet-node - [running an api instance with docker]: https://docs.hiro.so/get-started/running-api-node - [`stacks-blockchain`]: https://github.com/stacks-network/stacks-blockchain +- [Running a Stacks API node](https://docs.hiro.so/get-started/running-api-node) +- [Running a Stacks testnet node](running-testnet-node) diff --git a/src/pages/en/nodes-and-miners/running-testnet-node.md b/src/pages/en/nodes-and-miners/running-testnet-node.md index 07c6b7b6..cc4a893a 100644 --- a/src/pages/en/nodes-and-miners/running-testnet-node.md +++ b/src/pages/en/nodes-and-miners/running-testnet-node.md @@ -15,14 +15,11 @@ images: This procedure demonstrates how to run a local testnet node using Docker images. --> This procedure focuses on Unix-like operating systems (Linux and MacOS). This procedure has not been tested on -Windows. +-> This procedure focuses on Unix-like operating systems (Linux and MacOS). This procedure has not been tested on Windows. ## Prerequisites -Running a node has no specialized hardware requirements. Users have been successful in running nodes on Raspberry Pi -boards and other system-on-chip architectures. In order to complete this procedure, you must have the following software -installed on the node host machine: +Running a node has no specialized hardware requirements. Users have been successful in running nodes on Raspberry Pi boards and other system-on-chip architectures. In order to complete this procedure, you must have the following software installed on the node host machine: - [Docker](https://docs.docker.com/get-docker/) - [curl](https://curl.se/download.html) @@ -30,9 +27,7 @@ installed on the node host machine: ### Firewall configuration -In order for the API node services to work correctly, you must configure any network firewall rules to allow traffic on -the ports discussed in this section. The details of network and firewall configuration are highly specific to your -machine and network, so a detailed example isn't provided. +In order for the API node services to work correctly, you must configure any network firewall rules to allow traffic on the ports discussed in this section. The details of network and firewall configuration are highly specific to your machine and network, so a detailed example isn't provided. The following ports must open on the host machine: @@ -52,8 +47,7 @@ These egress ports are for syncing [`stacks-blockchain`][] and Bitcoin headers. ## Step 1: initial setup -In order to run the testnet node, you must download the Docker images and create a directory structure to hold the -persistent data from the services. Download and configure the Docker images with the following commands: +In order to run the testnet node, you must download the Docker images and create a directory structure to hold the persistent data from the services. Download and configure the Docker images with the following commands: ```sh docker pull blockstack/stacks-blockchain @@ -141,7 +135,5 @@ docker stop stacks-blockchain ## Additional reading -- [Running an API instance with Docker][] - [running a mainnet node with docker]: /understand-stacks/running-mainnet-node - [running an api instance with docker]: https://docs.hiro.so/get-started/running-api-node - [`stacks-blockchain`]: https://github.com/stacks-network/stacks-blockchain +- [Running a Stacks API node](https://docs.hiro.so/get-started/running-api-node) +- [Running a Stacks mainnet node](running-mainnet-node) diff --git a/src/pages/en/references/faqs.md b/src/pages/en/references/faqs.md deleted file mode 100644 index 75489f3e..00000000 --- a/src/pages/en/references/faqs.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: FAQs -description: Find answers related to the Stacks ecosystem. ---- - -## General Information - -Learn more about the user-owned internet on Bitcoin and the Stacks ecosystem on [stacks.co](https://stacks.co). - -## Apps and Smart Contracts - -Developers, get started building apps and contracts on the [developer page at stacks.co](https://www.stacks.co/developers). - -## Stacks Network - -Learn more about the network behind the user-owned internet on Bitcoin in the [Understand Stacks chapter](/understand-stacks/overview) in the docs. - -## Stacks Token - -Stacks fuel apps and smart contracts on Bitcoin. Learn more at [stackstoken.com](https://stackstoken.com/faq). - -## Stacks Wallet - -Download and find resources about the Stacks Wallet by Hiro at [hiro.so](https://www.hiro.so/wallet). diff --git a/src/pages/en/references/glossary.md b/src/pages/en/references/glossary.md index 5b78b581..18b35983 100644 --- a/src/pages/en/references/glossary.md +++ b/src/pages/en/references/glossary.md @@ -1,6 +1,9 @@ --- title: Glossary description: A comprehensive list of terms used within the ecosystem. +images: + large: /images/cli.svg + sm: /images/cli.svg --- export { convertGlossaryToJson as getStaticProps } from '@common/data/glossary'; diff --git a/src/pages/en/write-smart-contracts/language-functions.md b/src/pages/en/write-smart-contracts/language-functions.md index e830117b..096fc8c0 100644 --- a/src/pages/en/write-smart-contracts/language-functions.md +++ b/src/pages/en/write-smart-contracts/language-functions.md @@ -1,6 +1,9 @@ --- title: Functions description: See a detailed list of all functions for the Clarity language. +images: + large: /images/contract.svg + sm: /images/contract.svg --- export { convertClarityRefToMdx as getStaticProps } from '@common/data/clarity-ref';