Skip to content

Commit

Permalink
try build with alerts plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
skudasov committed Oct 30, 2024
1 parent 02f06a6 commit ca4ca20
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 3 deletions.
4 changes: 4 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ jobs:
with:
mdbook-version: '0.4.40'

- name: Install Pre-processors
run: |
cargo install mdbook-alerts
- name: Build
working-directory: book
run: |
Expand Down
7 changes: 6 additions & 1 deletion book/book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,9 @@ title = "Chainlink Testing Framework"
build-dir = "docs"

[output.html]
default-theme = "ayu"
default-theme = "ayu"

[preprocessor.alerts]

#[preprocessor.commit]
#command = "python preprocessors/commit.py"
2 changes: 1 addition & 1 deletion book/src/developing.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ Here we describe good practices for developing components for our framework.
Rules for components are simple:
- Component should declare some `Input` and an optional `Output` (we use that so we can skip or cache any component results)
- Components should be isolated, they should not return anything except basic types like `int`, `string`, `maps` or `structs`
- Component **must** have documentation under [Components](./framework/components/overview.md), here is an [example](./framework/components/blockchains/anvil.md)
- Component **must** have documentation under [Components](./framework/components/overview.md), here is an [example](./framework/components/blockchains/anvil.md)
4 changes: 3 additions & 1 deletion book/src/framework/test_configuration_overrides.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,6 @@ You can specify multiple file paths using `CTF_CONFIGS=path1,path2,path3`.

The framework will apply these configurations from right to left.

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

0 comments on commit ca4ca20

Please sign in to comment.