From abc012e88ef3065bab537f4f89e257a81cc599bd Mon Sep 17 00:00:00 2001 From: gnkz Date: Thu, 19 Oct 2023 14:11:19 -0600 Subject: [PATCH] docs: fix reference file names --- docs/src/SUMMARY.md | 44 ++++++++++++++++++------------------ docs/src/modules/accounts.md | 2 +- docs/src/modules/commands.md | 2 +- docs/src/modules/config.md | 2 +- docs/src/modules/context.md | 2 +- docs/src/modules/env.md | 2 +- docs/src/modules/events.md | 2 +- docs/src/modules/expect.md | 2 +- docs/src/modules/fe.md | 2 +- docs/src/modules/fmt.md | 2 +- docs/src/modules/forks.md | 2 +- docs/src/modules/fs.md | 2 +- docs/src/modules/gas.md | 2 +- docs/src/modules/huff.md | 2 +- docs/src/modules/json.md | 2 +- docs/src/modules/results.md | 4 ++-- docs/src/modules/strings.md | 2 +- docs/src/modules/utils.md | 2 +- 18 files changed, 40 insertions(+), 40 deletions(-) diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 914d80f1..d939a4d4 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -32,25 +32,25 @@ # References - [Accounts](./references/Accounts.md) -- [Commands](./references/commands.md) -- [Config](./references/config.md) -- [Context](./references/context.md) -- [Env](./references/env.md) -- [Error](./references/error.md) -- [Events](./references/events.md) -- [Expect](./references/expect.md) -- [Fe](./references/fe.md) -- [Fmt](./references/fmt.md) -- [Forks](./references/forks.md) -- [Fs](./references/fs.md) -- [Gas](./references/gas.md) -- [Huff](./references/huff.md) -- [Invariants](./references/invariants.md) -- [Json](./references/json.md) -- [Pointer](./references/pointer.md) -- [Result](./references/result.md) -- [Semver](./references/semver.md) -- [Strings](./references/strings.md) -- [Utils](./references/utils.md) -- [Vulcan](./references/vulcan.md) -- [Watchers](./references/watchers.md) +- [Commands](./references/Commands.md) +- [Config](./references/Config.md) +- [Context](./references/Context.md) +- [Env](./references/Env.md) +- [Error](./references/Error.md) +- [Events](./references/Events.md) +- [Expect](./references/Expect.md) +- [Fe](./references/Fe.md) +- [Fmt](./references/Fmt.md) +- [Forks](./references/Forks.md) +- [Fs](./references/Fs.md) +- [Gas](./references/Gas.md) +- [Huff](./references/Huff.md) +- [Invariants](./references/Invariants.md) +- [Json](./references/Json.md) +- [Pointer](./references/Pointer.md) +- [Result](./references/Result.md) +- [Semver](./references/Semver.md) +- [Strings](./references/Strings.md) +- [Utils](./references/Utils.md) +- [Vulcan](./references/Vulcan.md) +- [Watchers](./references/Watchers.md) diff --git a/docs/src/modules/accounts.md b/docs/src/modules/accounts.md index c021d587..39762f13 100644 --- a/docs/src/modules/accounts.md +++ b/docs/src/modules/accounts.md @@ -4,4 +4,4 @@ Utilities to operate over accounts (balances, impersonation, etc.) {{#include ../examples/accounts/example.md}} -[**Accounts API reference**](../references/accounts.md) +[**Accounts API reference**](../references/Accounts.md) diff --git a/docs/src/modules/commands.md b/docs/src/modules/commands.md index 56dc0f78..d557388f 100644 --- a/docs/src/modules/commands.md +++ b/docs/src/modules/commands.md @@ -5,4 +5,4 @@ work. The `commands` module uses [`Results`](./results.md) when returning values {{#include ../examples/commands/example.md}} -[**Commands API reference**](../references/commands.md) +[**Commands API reference**](../references/Commands.md) diff --git a/docs/src/modules/config.md b/docs/src/modules/config.md index 81cef79f..dd5daf8c 100644 --- a/docs/src/modules/config.md +++ b/docs/src/modules/config.md @@ -4,4 +4,4 @@ Access the Foundry project configuration. For now it can only read RPC URLs. {{#include ../examples/config/example.md}} -[**Config API reference**](../references/config.md) +[**Config API reference**](../references/Config.md) diff --git a/docs/src/modules/context.md b/docs/src/modules/context.md index fccaaaa7..5264b445 100644 --- a/docs/src/modules/context.md +++ b/docs/src/modules/context.md @@ -9,4 +9,4 @@ Functionality to interact with the current runtime context: {{#include ../examples/context/example.md}} -[**Context API reference**](../references/context.md) +[**Context API reference**](../references/Context.md) diff --git a/docs/src/modules/env.md b/docs/src/modules/env.md index 51aa570f..7d243c91 100644 --- a/docs/src/modules/env.md +++ b/docs/src/modules/env.md @@ -4,4 +4,4 @@ Set and read environmental variables. {{#include ../examples/env/example.md}} -[**Env API reference**](../references/env.md) +[**Env API reference**](../references/Env.md) diff --git a/docs/src/modules/events.md b/docs/src/modules/events.md index 56d2eeb8..a366fae2 100644 --- a/docs/src/modules/events.md +++ b/docs/src/modules/events.md @@ -4,4 +4,4 @@ Provides utilities to get logs and transform values into their topic representat {{#include ../examples/events/example.md}} -[**Events API reference**](../references/events.md) +[**Events API reference**](../references/Events.md) diff --git a/docs/src/modules/expect.md b/docs/src/modules/expect.md index 2856ad30..cd1d0736 100644 --- a/docs/src/modules/expect.md +++ b/docs/src/modules/expect.md @@ -8,4 +8,4 @@ checking across various data types. {{#include ../examples/expect/example.md}} -[**Expect API reference**](../references/expect.md) +[**Expect API reference**](../references/Expect.md) diff --git a/docs/src/modules/fe.md b/docs/src/modules/fe.md index d476e312..623f66d7 100644 --- a/docs/src/modules/fe.md +++ b/docs/src/modules/fe.md @@ -5,5 +5,5 @@ to work. This module requires the `fe` binary installed in order to work. {{ #include ../examples/fe/example.md }} -[**Fe API reference**](../references/fe.md) +[**Fe API reference**](../references/Fe.md) diff --git a/docs/src/modules/fmt.md b/docs/src/modules/fmt.md index 72200d20..0fa9f803 100644 --- a/docs/src/modules/fmt.md +++ b/docs/src/modules/fmt.md @@ -16,4 +16,4 @@ the number of decimals, for example `{u:d18}` to format numbers with `18` decima {{#include ../examples/format/example.md}} -[**Format API reference**](../references/fmt.md) +[**Format API reference**](../references/Fmt.md) diff --git a/docs/src/modules/forks.md b/docs/src/modules/forks.md index 9f697d89..cc53cdec 100644 --- a/docs/src/modules/forks.md +++ b/docs/src/modules/forks.md @@ -18,4 +18,4 @@ contract TestMyContract is Test { } } ``` -[**Forks API reference**](../references/forks.md) +[**Forks API reference**](../references/Forks.md) diff --git a/docs/src/modules/fs.md b/docs/src/modules/fs.md index d2b78e00..05e8757c 100644 --- a/docs/src/modules/fs.md +++ b/docs/src/modules/fs.md @@ -5,4 +5,4 @@ Provides utilities to interact with the filesystem. In order to use this module {{#include ../examples/fs/example.md}} -[**Fs API reference**](../references/fs.md) +[**Fs API reference**](../references/Fs.md) diff --git a/docs/src/modules/gas.md b/docs/src/modules/gas.md index 5652991d..feb9026e 100644 --- a/docs/src/modules/gas.md +++ b/docs/src/modules/gas.md @@ -2,4 +2,4 @@ Provides method to measure gas usage in a more granular way. {{#include ../examples/gas/example.md}} -[**Gas API reference**](../references/gas.md) +[**Gas API reference**](../references/Gas.md) diff --git a/docs/src/modules/huff.md b/docs/src/modules/huff.md index f9b7de8c..55a9b596 100644 --- a/docs/src/modules/huff.md +++ b/docs/src/modules/huff.md @@ -5,4 +5,4 @@ to work. This module requires the `huffc` binary installed in order to work. {{ #include ../examples/huff/example.md }} -[**Huff API reference**](../references/huff.md) +[**Huff API reference**](../references/Huff.md) diff --git a/docs/src/modules/json.md b/docs/src/modules/json.md index 3b2ea9d3..5b420353 100644 --- a/docs/src/modules/json.md +++ b/docs/src/modules/json.md @@ -4,4 +4,4 @@ Manipulate JSON data. {{#include ../examples/json/example.md}} -[**Json API reference**](../references/json.md) +[**Json API reference**](../references/Json.md) diff --git a/docs/src/modules/results.md b/docs/src/modules/results.md index d46c73b1..1bc4b1b7 100644 --- a/docs/src/modules/results.md +++ b/docs/src/modules/results.md @@ -12,6 +12,6 @@ Similar to Rust's Results API, Vulcan implements the following functions for all {{#include ../examples/results/example.md}} -[**Results API reference**](../references/result.md) +[**Results API reference**](../references/Result.md) -[**Errors API reference**](../references/error.md) +[**Errors API reference**](../references/Error.md) diff --git a/docs/src/modules/strings.md b/docs/src/modules/strings.md index bd53868a..19eedb6a 100644 --- a/docs/src/modules/strings.md +++ b/docs/src/modules/strings.md @@ -4,4 +4,4 @@ Convert basic types from / to strings. {{#include ../examples/strings/example.md}} -[**Strings API reference**](../references/strings.md) +[**Strings API reference**](../references/Strings.md) diff --git a/docs/src/modules/utils.md b/docs/src/modules/utils.md index b9fa1cdf..7d7e32e6 100644 --- a/docs/src/modules/utils.md +++ b/docs/src/modules/utils.md @@ -9,4 +9,4 @@ Some of the utility functions: {{#include ../examples/utils/example.md}} -[**Utils API reference**](../references/utils.md) +[**Utils API reference**](../references/Utils.md)