Skip to content

[Docs] Fix links and make paths absolute #3885

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

Merged
merged 7 commits into from
Apr 14, 2025
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ avalanche network status

A node needs to catch up to the latest network state before it can participate in consensus and serve API calls. This process (called bootstrapping) currently takes several days for a new node connected to Mainnet.

A node will not [report healthy](https://docs.avax.network/api-reference/health-api) until it is done bootstrapping.
A node will not [report healthy](https://build.avax.network/docs/api-reference/health-api) until it is done bootstrapping.

Improvements that reduce the amount of time it takes to bootstrap are under development.

Expand Down
10 changes: 5 additions & 5 deletions api/admin/service.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
The Admin API can be used for measuring node health and debugging.

<Callout title="Note">
The Admin API is disabled by default for security reasons. To run a node with the Admin API enabled, use [`config flag --api-admin-enabled=true`](/nodes/configure/configs-flags#--api-admin-enabled-boolean).
The Admin API is disabled by default for security reasons. To run a node with the Admin API enabled, use [`config flag --api-admin-enabled=true`](https://build.avax.network/docs/nodes/configure/configs-flags#--api-admin-enabled-boolean).

This API set is for a specific node, it is unavailable on the [public server](/tooling/rpc-providers).
This API set is for a specific node, it is unavailable on the [public server](https://build.avax.network/docs/tooling/rpc-providers).
</Callout>

## Format

This API uses the `json 2.0` RPC format. For details, see [here](/api-reference/standards/guides/issuing-api-calls).
This API uses the `json 2.0` RPC format. For details, see [here](https://build.avax.network/docs/api-reference/guides/issuing-api-calls).

## Endpoint

Expand Down Expand Up @@ -63,7 +63,7 @@ Now, calls to the X-Chain can be made to either `/ext/bc/X` or, equivalently, to
Give a blockchain an alias, a different name that can be used any place the blockchain's ID is used.

<Callout title="Note">
Aliasing a chain can also be done via the [Node API](/nodes/configure/configs-flags#--chain-aliases-file-string).
Aliasing a chain can also be done via the [Node API](https://build.avax.network/docs/nodes/configure/configs-flags#--chain-aliases-file-string).

Note that the alias is set for each chain on each node individually. In a multi-node Avalanche L1, the same alias should be configured on each node to use an alias across an Avalanche L1 successfully. Setting an alias for a chain on one node does not register that alias with other nodes automatically.
</Callout>
Expand Down Expand Up @@ -208,7 +208,7 @@ curl -X POST --data '{

### `admin.loadVMs`

Dynamically loads any virtual machines installed on the node as plugins. See [here](/virtual-machines#installing-a-vm) for more information on how to install a virtual machine on a node.
Dynamically loads any virtual machines installed on the node as plugins. See [here](https://build.avax.network/docs/virtual-machines#installing-a-vm) for more information on how to install a virtual machine on a node.

**Signature**:

Expand Down
6 changes: 3 additions & 3 deletions api/health/service.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
The Health API can be used for measuring node health.

<Callout title="Note">
This API set is for a specific node; it is unavailable on the [public server](/tooling/rpc-providers).
This API set is for a specific node; it is unavailable on the [public server](https://build.avax.network/docs/tooling/rpc-providers).
</Callout>

## Health Checks

The node periodically runs all health checks, including health checks for each chain.

The frequency at which health checks are run can be specified with the [\--health-check-frequency](/nodes/configure/configs-flags) flag.
The frequency at which health checks are run can be specified with the [\--health-check-frequency](https://build.avax.network/docs/nodes/configure/configs-flags) flag.

## Filterable Health Checks

Expand Down Expand Up @@ -51,7 +51,7 @@ The available endpoints for GET requests are:

### Format

This API uses the `json 2.0` RPC format. For more information on making JSON RPC calls, see [here](/api-reference/standards/guides/issuing-api-calls).
This API uses the `json 2.0` RPC format. For more information on making JSON RPC calls, see [here](https://build.avax.network/docs/api-reference/guides/issuing-api-calls).

### Endpoint

Expand Down
10 changes: 5 additions & 5 deletions api/info/service.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ The Info API can be used to access basic information about an Avalanche node.

## Format

This API uses the `json 2.0` RPC format. For more information on making JSON RPC calls, see [here](/api-reference/standards/guides/issuing-api-calls).
This API uses the `json 2.0` RPC format. For more information on making JSON RPC calls, see [here](https://build.avax.network/docs/api-reference/guides/issuing-api-calls).

## Endpoint

Expand Down Expand Up @@ -142,7 +142,7 @@ curl -X POST --data '{

### `info.getBlockchainID`

Given a blockchain's alias, get its ID. (See [`admin.aliasChain`](/api-reference/admin-api#adminaliaschain).)
Given a blockchain's alias, get its ID. (See [`admin.aliasChain`](https://build.avax.network/docs/api-reference/admin-api#adminaliaschain).)

**Signature**:

Expand Down Expand Up @@ -246,7 +246,7 @@ curl -X POST --data '{
Get the ID, the BLS key, and the proof of possession(BLS signature) of this node.

<Callout title="Note">
This endpoint set is for a specific node, it is unavailable on the [public server](/tooling/rpc-providers).
This endpoint set is for a specific node, it is unavailable on the [public server](https://build.avax.network/docs/tooling/rpc-providers).
</Callout>

**Signature**:
Expand Down Expand Up @@ -297,7 +297,7 @@ curl -X POST --data '{
Get the IP of this node.

<Callout title="Note">
This endpoint set is for a specific node, it is unavailable on the [public server](/tooling/rpc-providers).
This endpoint set is for a specific node, it is unavailable on the [public server](https://build.avax.network/docs/tooling/rpc-providers).
</Callout>

**Signature**:
Expand Down Expand Up @@ -454,7 +454,7 @@ curl -X POST --data '{
Get the virtual machines installed on this node.

<Callout title="Note">
This endpoint set is for a specific node, it is unavailable on the [public server](/tooling/rpc-providers).
This endpoint set is for a specific node, it is unavailable on the [public server](https://build.avax.network/docs/tooling/rpc-providers).
</Callout>

**Signature**:
Expand Down
4 changes: 2 additions & 2 deletions api/metrics/service.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
The Metrics API allows clients to get statistics about a node's health and performance.

<Callout title="Note">
This API set is for a specific node, it is unavailable on the [public server](/tooling/rpc-providers).
This API set is for a specific node, it is unavailable on the [public server](https://build.avax.network/docs/tooling/rpc-providers).
</Callout>

## Endpoint
Expand All @@ -22,4 +22,4 @@ curl -X POST 127.0.0.1:9650/ext/metrics

This API produces Prometheus compatible metrics. See [here](https://github.com/prometheus/docs/blob/master/content/docs/instrumenting/exposition_formats.md) for information on Prometheus' formatting.

[Here](/nodes/maintain/monitoring) is a tutorial that shows how to set up Prometheus and Grafana to monitor AvalancheGo node using the Metrics API.
[Here](https://build.avax.network/docs/nodes/maintain/monitoring) is a tutorial that shows how to set up Prometheus and Grafana to monitor AvalancheGo node using the Metrics API.
33 changes: 13 additions & 20 deletions config/config.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
---
tags: [Nodes]
description: This document lists all available configuration and flags for AvalancheGo.
sidebar_label: AvalancheGo Configs + Flags
pagination_label: AvalancheGo Configs and Flags
sidebar_position: 0
---

# AvalancheGo Configs and Flags

<!-- markdownlint-disable MD001 -->
Expand All @@ -17,28 +9,28 @@ You can specify the configuration of a node with the arguments below.
#### `--api-admin-enabled` (boolean)

If set to `true`, this node will expose the Admin API. Defaults to `false`.
See [here](docs.avax.network/reference/avalanchego/admin-api) for more information.
See [here](https://build.avax.network/docs/api-reference/admin-api) for more information.

#### `--api-health-enabled` (boolean)

If set to `false`, this node will not expose the Health API. Defaults to `true`. See
[here](docs.avax.network/reference/avalanchego/health-api) for more information.
[here](https://build.avax.network/docs/api-reference/health-api) for more information.

#### `--index-enabled` (boolean)

If set to `true`, this node will enable the indexer and the Index API will be
available. Defaults to `false`. See
[here](docs.avax.network/reference/avalanchego/index-api) for more information.
[here](https://build.avax.network/docs/api-reference/index-api) for more information.

#### `--api-info-enabled` (boolean)

If set to `false`, this node will not expose the Info API. Defaults to `true`. See
[here](docs.avax.network/reference/avalanchego/info-api) for more information.
[here](https://build.avax.network/docs/api-reference/info-api) for more information.

#### `--api-metrics-enabled` (boolean)

If set to `false`, this node will not expose the Metrics API. Defaults to
`true`. See [here](docs.avax.network/reference/avalanchego/metrics-api) for more information.
`true`. See [here](https://build.avax.network/docs/api-reference/metrics-api) for more information.

## Avalanche Community Proposals

Expand Down Expand Up @@ -106,7 +98,7 @@ them into the VM on initialization.
#### `--chain-config-dir` (string)

Specifies the directory that contains chain configs, as described
[here](docs.avax.network/nodes/configure/chain-configs/chain-config-flags). Defaults to `$HOME/.avalanchego/configs/chains`.
[here](https://build.avax.network/docs/nodes/chain-configs). Defaults to `$HOME/.avalanchego/configs/chains`.
If this flag is not provided and the default directory does not exist,
AvalancheGo will not exit since custom configs are optional. However, if the
flag is set, the specified folder must exist, or AvalancheGo will exit with an
Expand Down Expand Up @@ -134,10 +126,10 @@ The chain configuration is intended to provide optional configuration parameters
and the VM will use default values if nothing is passed in.

Full reference for all configuration options for some standard chains can be
found in a separate [chain config flags](docs.avax.network/nodes/configure/chain-configs/chain-config-flags) document.
found in a separate [chain config flags](https://build.avax.network/docs/nodes/chain-configs) document.

Full reference for `subnet-evm` upgrade configuration can be found in a separate
[Customize a Subnet](docs.avax.network/build/subnet/upgrade/customize-a-subnet) document.
[Customize a Subnet](https://build.avax.network/docs/avalanche-l1s/upgrade/customize-avalanche-l1) document.

#### `--chain-config-content` (string)

Expand Down Expand Up @@ -198,9 +190,9 @@ Example JSON config file:
```

:::tip
[Install Script](https://docs.avax.network/tooling/avalanche-go-installer) creates the
[Install Script](https://build.avax.network/docs/tooling/avalanche-go-installer) creates the
node config file at `~/.avalanchego/configs/node.json`. No default file is
created if [AvalancheGo is built from source](https://docs.avax.network/nodes/run-a-node/manually), you
created if [AvalancheGo is built from source](https://build.avax.network/docs/nodes/run-a-node/from-source), you
would need to create it manually if needed.
:::

Expand Down Expand Up @@ -717,7 +709,7 @@ configs for Subnets specified in
`--track-subnets` parameter.

Full reference for all configuration options for a Subnet can be found in a
separate [Subnet Configs](https://docs.avax.network/nodes/configure/avalanche-l1-configs) document.
separate [Subnet Configs](https://build.avax.network/docs/nodes/configure/avalanche-l1-configs) document.

#### `--subnet-config-dir` (`string`)

Expand Down Expand Up @@ -1315,7 +1307,7 @@ GiB).

#### `--plugin-dir` (string)

Sets the directory for [VM plugins](https://docs.avax.network/virtual-machines). The default value is `$HOME/.avalanchego/plugins`.
Sets the directory for [VM plugins](https://build.avax.network/docs/virtual-machines). The default value is `$HOME/.avalanchego/plugins`.

### Virtual Machine (VM) Configs

Expand Down Expand Up @@ -1360,3 +1352,4 @@ Node reports unhealthy if the router drops more than this portion of messages. D

Node reports unhealthy if there are more than this many outstanding consensus requests
(Get, PullQuery, etc.) over all chains. Defaults to `1024`.

4 changes: 2 additions & 2 deletions indexer/service.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
AvalancheGo can be configured to run with an indexer. That is, it saves (indexes) every container (a block, vertex or transaction) it accepts on the X-Chain, P-Chain and C-Chain. To run AvalancheGo with indexing enabled, set command line flag [\--index-enabled](https://docs.avax.network/nodes/configure/configs-flags#--index-enabled-boolean) to true.
AvalancheGo can be configured to run with an indexer. That is, it saves (indexes) every container (a block, vertex or transaction) it accepts on the X-Chain, P-Chain and C-Chain. To run AvalancheGo with indexing enabled, set command line flag [\--index-enabled](https://build.avax.network/docs/nodes/configure/configs-flags#--index-enabled-boolean) to true.

**AvalancheGo will only index containers that are accepted when running with `--index-enabled` set to true.** To ensure your node has a complete index, run a node with a fresh database and `--index-enabled` set to true. The node will accept every block, vertex and transaction in the network history during bootstrapping, ensuring your index is complete.

Expand All @@ -16,7 +16,7 @@ There is a Go implementation of an Index API client. See documentation [here](ht

## Format

This API uses the `json 2.0` RPC format. For more information on making JSON RPC calls, see [here](https://docs.avax.network/api-reference/standards/guides/issuing-api-calls).
This API uses the `json 2.0` RPC format. For more information on making JSON RPC calls, see [here](https://build.avax.network/docs/api-reference/guides/issuing-api-calls).

## Endpoints

Expand Down
2 changes: 1 addition & 1 deletion network/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ sequenceDiagram

## Peer Discovery

When starting an Avalanche node, a node needs to be able to initiate some process that eventually allows itself to become a participating member of the network. In traditional web2 systems, it's common to use a web service by hitting the service's DNS and being routed to an available server behind a load balancer. In decentralized p2p systems, however, connecting to a node is more complex as no single entity owns the network. [Avalanche consensus](https://docs.avax.network/overview/getting-started/avalanche-consensus) requires a node to repeatedly sample peers in the network, so each node needs some way of discovering and connecting to every other peer to participate in the protocol.
When starting an Avalanche node, a node needs to be able to initiate some process that eventually allows itself to become a participating member of the network. In traditional web2 systems, it's common to use a web service by hitting the service's DNS and being routed to an available server behind a load balancer. In decentralized p2p systems, however, connecting to a node is more complex as no single entity owns the network. [Avalanche consensus](https://build.avax.network/docs/quick-start/avalanche-consensus) requires a node to repeatedly sample peers in the network, so each node needs some way of discovering and connecting to every other peer to participate in the protocol.

### Inbound Connections

Expand Down
14 changes: 3 additions & 11 deletions subnets/config.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,11 @@
---
tags: [Nodes]
description: Reference for all available Subnet config options and flags.
sidebar_label: Subnet Configs
pagination_label: Subnet Configs
sidebar_position: 2
---

# Subnet Configs

It is possible to provide parameters for a Subnet. Parameters here apply to all
chains in the specified Subnet.

AvalancheGo looks for files specified with `{subnetID}.json` under
`--subnet-config-dir` as documented
[here](/nodes/configure/avalanchego-config-flags.md#subnet-configs).
[here](https://build.avax.network/docs/nodes/configure/configs-flags#subnet-configs).

Here is an example of Subnet config file:

Expand Down Expand Up @@ -78,7 +70,7 @@ frequency at which blocks are built.
Subnet configs supports loading new consensus parameters. JSON keys are
different from their matching `CLI` keys. These parameters must be grouped under
`consensusParameters` key. The consensus parameters of a Subnet default to the
same values used for the Primary Network, which are given [CLI Snow Parameters](/nodes/configure/avalanchego-config-flags.md#snow-parameters).
same values used for the Primary Network, which are given [CLI Snow Parameters](https://build.avax.network/docs/nodes/configure/configs-flags#snow-parameters).

| CLI Key | JSON Key |
| :------------------------------- | :-------------------- |
Expand All @@ -98,7 +90,7 @@ It's possible to define different Gossip configurations for each Subnet without
changing values for Primary Network. JSON keys of these
parameters are different from their matching `CLI` keys. These parameters
default to the same values used for the Primary Network. For more information
see [CLI Gossip Configs](/nodes/configure/avalanchego-config-flags.md#gossiping).
see [CLI Gossip Configs](https://build.avax.network/docs/nodes/configure/configs-flags#gossiping).

| CLI Key | JSON Key |
| :------------------------------------------------------ | :------------------------------------- |
Expand Down
4 changes: 2 additions & 2 deletions vms/avm/service.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
The [X-Chain](/learn/avalanche/avalanche-platform.md#x-chain),
The [X-Chain](https://build.avax.network/docs/quick-start/primary-network#x-chain),
Avalanche's native platform for creating and trading assets, is an instance of the Avalanche Virtual
Machine (AVM). This API allows clients to create and trade assets on the X-Chain and other instances
of the AVM.

## Format

This API uses the `json 2.0` RPC format. For more information on making JSON RPC calls, see
[here](/reference/standards/guides/issuing-api-calls.md).
[here](https://build.avax.network/docs/api-reference/guides/issuing-api-calls).

## Endpoints

Expand Down
9 changes: 4 additions & 5 deletions vms/example/xsvm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Cross Subnet Asset Transfers README Overview

## Avalanche Subnets and Custom VMs

Avalanche is a network composed of multiple sub-networks (called [subnets][Subnet]) that each contain any number of blockchains. Each blockchain is an instance of a [Virtual Machine (VM)](https://docs.avax.network/learn/platform-overview#virtual-machines), much like an object in an object-oriented language is an instance of a class. That is, the VM defines the behavior of the blockchain where it is instantiated. For example, [Coreth (EVM)][Coreth] is a VM that is instantiated by the [C-Chain]. Likewise, one could deploy another instance of the EVM as their own blockchain (to take this to its logical conclusion).
Avalanche is a network composed of multiple sub-networks (called [subnets][Subnet]) that each contain any number of blockchains. Each blockchain is an instance of a [Virtual Machine (VM)](https://build.avax.network/docs/quick-start/virtual-machines), much like an object in an object-oriented language is an instance of a class. That is, the VM defines the behavior of the blockchain where it is instantiated. For example, [Coreth (EVM)][Coreth] is a VM that is instantiated by the [C-Chain]. Likewise, one could deploy another instance of the EVM as their own blockchain (to take this to its logical conclusion).

## Introduction

Expand Down Expand Up @@ -284,11 +284,10 @@ P-Chain.
You can do this by following the [subnet tutorial] or by using the [subnet-cli].

[teleporter]: https://github.com/ava-labs/avalanchego/tree/master/vms/platformvm/teleporter
[subnet tutorial]: https://docs.avax.network/build/tutorials/platform/subnets/create-a-subnet
[subnet-cli]: https://github.com/ava-labs/subnet-cli
[subnet tutorial]: https://build.avax.network/docs/tooling/create-avalanche-l1
[Coreth]: https://github.com/ava-labs/coreth
[C-Chain]: https://docs.avax.network/learn/platform-overview/#contract-chain-c-chain
[Subnet]: https://docs.avax.network/learn/platform-overview/#subnets
[C-Chain]: https://build.avax.network/docs/quick-start/primary-network#c-chain
[Subnet]: https://build.avax.network/docs/avalanche-l1s

## Cross Subnet Transaction Example

Expand Down
Loading