Skip to content

Commit ca4ca20

Browse files
committed
try build with alerts plugin
1 parent 02f06a6 commit ca4ca20

File tree

4 files changed

+14
-3
lines changed

4 files changed

+14
-3
lines changed

.github/workflows/docs.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ jobs:
1717
with:
1818
mdbook-version: '0.4.40'
1919

20+
- name: Install Pre-processors
21+
run: |
22+
cargo install mdbook-alerts
23+
2024
- name: Build
2125
working-directory: book
2226
run: |

book/book.toml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,9 @@ title = "Chainlink Testing Framework"
99
build-dir = "docs"
1010

1111
[output.html]
12-
default-theme = "ayu"
12+
default-theme = "ayu"
13+
14+
[preprocessor.alerts]
15+
16+
#[preprocessor.commit]
17+
#command = "python preprocessors/commit.py"

book/src/developing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ Here we describe good practices for developing components for our framework.
55
Rules for components are simple:
66
- Component should declare some `Input` and an optional `Output` (we use that so we can skip or cache any component results)
77
- Components should be isolated, they should not return anything except basic types like `int`, `string`, `maps` or `structs`
8-
- Component **must** have documentation under [Components](./framework/components/overview.md), here is an [example](./framework/components/blockchains/anvil.md)
8+
- Component **must** have documentation under [Components](./framework/components/overview.md), here is an [example](./framework/components/blockchains/anvil.md)

book/src/framework/test_configuration_overrides.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,6 @@ You can specify multiple file paths using `CTF_CONFIGS=path1,path2,path3`.
66

77
The framework will apply these configurations from right to left.
88

9-
**REMINDER**: when override slices remember that you should replace the full slice, it won't be extended by default!
9+
> [!NOTE]
10+
> When override slices remember that you should replace the full slice, it won't be extended by default!
11+

0 commit comments

Comments
 (0)