Skip to content

Commit

Permalink
docs: fix reference file names
Browse files Browse the repository at this point in the history
  • Loading branch information
gnkz committed Oct 19, 2023
1 parent 2e36d0e commit abc012e
Show file tree
Hide file tree
Showing 18 changed files with 40 additions and 40 deletions.
44 changes: 22 additions & 22 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/src/modules/accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/src/modules/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/src/modules/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/src/modules/context.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/src/modules/env.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/src/modules/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/src/modules/expect.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/src/modules/fe.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

2 changes: 1 addition & 1 deletion docs/src/modules/fmt.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/src/modules/forks.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ contract TestMyContract is Test {
}
}
```
[**Forks API reference**](../references/forks.md)
[**Forks API reference**](../references/Forks.md)
2 changes: 1 addition & 1 deletion docs/src/modules/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/src/modules/gas.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/src/modules/huff.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/src/modules/json.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Manipulate JSON data.

{{#include ../examples/json/example.md}}

[**Json API reference**](../references/json.md)
[**Json API reference**](../references/Json.md)
4 changes: 2 additions & 2 deletions docs/src/modules/results.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/src/modules/strings.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/src/modules/utils.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit abc012e

Please sign in to comment.