Skip to content

Commit ab5996a

Browse files
committed
use relative path in documents
Many entries in the documentation are pointing to docs.onflow.org as the official Flow doc site was unable to handle relative links well. This change aims to change links to be relative links so that readers can stay in Github when reading the doc.
1 parent e7cb072 commit ab5996a

12 files changed

Lines changed: 21 additions & 21 deletions

docs/build-transactions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ transaction to be executed.
8181
matching argument type in transaction code.
8282

8383
Input arguments values matching corresponding types in the source code and passed in the same order.
84-
For passing complex argument values see [send transaction](https://docs.onflow.org/flow-cli/send-transactions/#example-usage) document.
84+
For passing complex argument values see [send transaction](send-transactions.md#example-usage) document.
8585

8686
## Flags
8787

docs/configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ Flow configuration (`flow.json`) file will contain the following properties:
1111
- A `networks` list pre-populated with the Flow emulator, testnet and mainnet connection configuration.
1212
- An `accounts` list pre-populated with the Flow Emulator service account.
1313
- An `emulators` list pre-populated with Flow Emulator configuration.
14-
- A `deployments` empty object where all [deployment targets](https://docs.onflow.org/flow-cli/project-contracts/) can be defined.
15-
- A `contracts` empty object where you [define contracts](https://docs.onflow.org/flow-cli/project-contracts/) you wish to deploy.
14+
- A `deployments` empty object where all [deployment targets](project-contracts.md) can be defined.
15+
- A `contracts` empty object where you [define contracts](project-contracts.md) you wish to deploy.
1616

1717
## Example Project Configuration
1818

docs/deploy-project-contracts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This command automatically deploys your project's contracts based on the
1212
configuration defined in your `flow.json` file.
1313

1414
Before using this command, read about how to
15-
[configure project contracts and deployment targets](https://docs.onflow.org/flow-cli/project-contracts/).
15+
[configure project contracts and deployment targets](project-contracts.md).
1616

1717
## Example Usage
1818

@@ -88,7 +88,7 @@ used during the deployment. Example:
8888

8989

9090
⚠️ Warning: before proceeding,
91-
we recommend reading the [Flow CLI security guidelines](https://docs.onflow.org/flow-cli/security/)
91+
we recommend reading the [Flow CLI security guidelines](security.md)
9292
to learn about the best practices for private key storage.
9393

9494
## Dependency Resolution

docs/developer-updates/release-notes-v17.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## ⬆️ Install or Upgrade
22

3-
Follow the [Flow CLI installation guide](https://docs.onflow.org/flow-cli/install/) for instructions on how to install or upgrade the CLI.
3+
Follow the [Flow CLI installation guide](../install.md) for instructions on how to install or upgrade the CLI.
44

55
## 💥 Breaking Changes
66

@@ -12,7 +12,7 @@ The new format is not backwards compatible with the old format.
1212

1313
If needed, you can generate a new configuration file with the `flow init` command.
1414

15-
Read more about the new configuration format in the [documentation](https://docs.onflow.org/flow-cli/configuration).
15+
Read more about the new configuration format in the [documentation](../configuration.md).
1616

1717
### Updated: `flow blocks get`
1818

@@ -31,7 +31,7 @@ flow blocks get 6bb0e0fceef9225a3cf9ceb6df9a31bd0063e6ee8e8dd7fdd93b831783243cd3
3131
flow blocks get 28329914
3232
```
3333

34-
Read more about this change in the [documentation](https://docs.onflow.org/flow-cli/get-blocks).
34+
Read more about this change in the [documentation](../get-blocks.md).
3535

3636
### Removed: `flow keys decode`
3737

@@ -102,7 +102,7 @@ more about them in the documentation on each command:
102102
- Filter: `--filter` Specify any property name from the result you want to return as the only value.
103103

104104
All the flags and their allowed values are specified
105-
for each command in the [documentation](https://docs.onflow.org/flow-cli/).
105+
for each command in the [documentation](../index.md).
106106

107107
Changed output for fetching account.
108108
```
@@ -146,7 +146,7 @@ to be reused.
146146
### Account Staking Info Command
147147

148148
New command to fetch staking info from the account was added. Read more about it in the
149-
[documentation](https://docs.onflow.org/flow-cli/staking-info).
149+
[documentation](../account-staking-info.md).
150150

151151
```shell
152152
> accounts staking-info 535b975637fb6bee --host access.testnet.nodes.onflow.org:9000

docs/developer-updates/release-notes-v18.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## ⬆️ Install or Upgrade
22

3-
Follow the [Flow CLI installation guide](https://docs.onflow.org/flow-cli/install/) for instructions on how to install or upgrade the CLI.
3+
Follow the [Flow CLI installation guide](../install.md) for instructions on how to install or upgrade the CLI.
44

55
## ⭐ Features
66

@@ -43,7 +43,7 @@ or address. Example:
4343
flow transactions build ./transaction.cdc --proposer alice --payer bob --authorizer bob --filter payload --save payload1.rlp
4444
```
4545

46-
Check more about [this functionality in docs](https://docs.onflow.org/flow-cli/build-transactions/).
46+
Check more about [this functionality in docs](../build-transactions.md).
4747

4848
#### Sign Transaction
4949
After using build command and saving payload to a file you should sign the transaction
@@ -66,7 +66,7 @@ Automatically checks if a new version exists and outputs a warning in case there
6666
is a newer version. Example:
6767
```
6868
⚠️ Version Warning: New version v0.18.0 of Flow CLI is available.
69-
Follow the Flow CLI installation guide for instructions on how to install or upgrade the CLI: https://docs.onflow.org/flow-cli/install
69+
Follow the Flow [CLI installation guide](../install.md) for instructions on how to install or upgrade the CLI
7070
```
7171

7272

docs/developer-updates/release-notes-v19.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## ⬆️ Install or Upgrade
22

3-
Follow the [Flow CLI installation guide](https://docs.onflow.org/flow-cli/install/) for instructions on how to install or upgrade the CLI.
3+
Follow the [Flow CLI installation guide](../install.md) for instructions on how to install or upgrade the CLI.
44

55
## ⭐ Features
66

@@ -51,7 +51,7 @@ Global flow configuration is saved as:
5151
- Linux: `~/flow.json`
5252
- Windows: `C:\Users\$USER\flow.json`
5353

54-
You can read more about it in [the docs](https://docs.onflow.org/flow-cli/initialize-configuration/).
54+
You can read more about it in [the docs](../initialize-configuration.md).
5555

5656
### Environment File Support
5757

docs/developer-updates/release-notes-v21.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## ⬆️ Install or Upgrade
22

3-
Follow the [Flow CLI installation guide](https://docs.onflow.org/flow-cli/install/) for instructions on how to install or upgrade the CLI.
3+
Follow the [Flow CLI installation guide](../install.md) for instructions on how to install or upgrade the CLI.
44

55

66
## 💥 Breaking Changes

docs/developer-updates/release-notes-v24.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## ⬆️ Install or Upgrade
22

3-
Follow the [Flow CLI installation guide](https://docs.onflow.org/flow-cli/install/) for instructions on how to install or upgrade the CLI.
3+
Follow the [Flow CLI installation guide](../install.md) for instructions on how to install or upgrade the CLI.
44

55
## 💥 Breaking Changes
66

docs/execute-scripts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Input arguments values matching corresponding types in the source code and passe
5454
Arguments passed to the Cadence script in `Type:Value` format.
5555
The `Type` must be the same as type in the script source code for that argument.
5656

57-
For passing complex argument values see [send transaction](https://docs.onflow.org/flow-cli/send-transactions/#example-usage) document.
57+
For passing complex argument values see [send transaction](send-transactions.md#example-usage) document.
5858

5959
⚠️ Deprecated: use command arguments instead.
6060

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ or sending transactions. It also includes the [Flow Emulator](https://docs.onflo
99

1010
## Installation
1111

12-
Follow [these steps](https://docs.onflow.org/flow-cli/install) to install the Flow CLI on
12+
Follow [these steps](./install.md) to install the Flow CLI on
1313
macOS, Linux, and Windows.

0 commit comments

Comments
 (0)