Docs cleanup

book/book.toml

@@ -12,6 +12,10 @@ build-dir = "docs"
 default-theme = "ayu"
 additional-js = ["mermaid.min.js", "mermaid-init.js"]
 
+[output.html.fold]
+enable = true
+level = 0
+
 [preprocessor.alerts]
 [preprocessor.cmdrun]
 

book/src/SUMMARY.md

@@ -2,70 +2,59 @@
 
 - [Overview](./overview.md)
 - [Framework](./framework/overview.md)
+- [Basic Usage](./framework/getting_started.md)
   - [Getting Started](./framework/getting_started.md)
   - [Your First Test](./framework/first_test.md)
   - [NodeSet Environment](./framework/nodeset_environment.md)
-  - [NodeSet Environment (Import Keys)](./framework/nodeset_environment_import.md)
-  - [NodeSet with Capabilities](./framework/nodeset_capabilities.md)
+  - [NodeSet (Capabilities)](./framework/nodeset_capabilities.md)
   - [NodeSet (Local Docker builds)](./framework/nodeset_docker_rebuild.md)
-  - [NodeSet Compat Environment](./framework/nodeset_compatibility.md)
+- [Advanced Usage](./framework/configuration.md)
+  - [CLI](./framework/cli.md)
+  - [Configuration](./framework/configuration.md)
+  - [Debugging Tests](framework/components/debug.md)
   - [Creating your own components](./developing/developing_components.md)
+  - [Exposing Components](framework/components/state.md)
   - [Asserting Logs](./developing/asserting_logs.md)
   - [Quick Contracts Deployment](./framework/quick_deployment.md)
   - [Verifying Contracts](./framework/verify.md)
-  - [NodeSet with External Blockchain]()
-  - [CLI](./framework/cli.md)
-  - [Configuration](./framework/configuration.md)
+  - [CL Node Keys Import](./framework/cl_node_keys_import.md)
   - [Test Configuration](./framework/test_configuration_overrides.md)
-  - [Exposing Components](framework/components/state.md)
-  - [Debugging Tests](framework/components/debug.md)
   - [Debugging K8s Chaos Tests](framework/chaos/debug-k8s.md)
   - [Components Cleanup](framework/components/cleanup.md)
   - [Components Caching](framework/components/caching.md)
   - [Components Resources](framework/components/resources.md)
   - [Containers Network Isolation](framework/components/network_isolation.md)
-  - [Faking Services](framework/components/mocking.md)
+  - [Fake Services](framework/components/mocking.md)
   - [Copying Files](framework/copying_files.md)
   - [External Environment](framework/components/external.md)
-  - [Troubleshooting](framework/components/troubleshooting.md)
-  - [Secrets]()
-  - [Observability Stack](framework/observability/observability_stack.md)
-    - [Metrics](framework/observability/metrics.md)
-    - [Logs](framework/observability/logs.md)
-    - [Profiling](framework/observability/profiling.md)
-    - [PostgreSQL](framework/observability/postgresql.md)
-    - [Traces]()
-  - [Blockscout](framework/observability/blockscout.md)
-  - [Components](framework/components/overview.md)
-    - [Blockchains](framework/components/blockchains/overview.md)
-      - [EVM](framework/components/blockchains/evm.md)
-      - [Solana](framework/components/blockchains/solana.md)
-      - [Aptos](framework/components/blockchains/aptos.md)
-      - [Sui](framework/components/blockchains/sui.md)
-      - [TRON](framework/components/blockchains/tron.md)
-      - [ZKSync](framework/components/blockchains/zksync.md)
-      - [Ton](framework/components/blockchains/ton.md)
-      - [Optimism Stack]()
-      - [Arbitrum Stack]()
-    - [Chainlink](framework/components/chainlink.md)
-      - [Node](framework/components/chainlink/node.md)
-      - [NodeSet](framework/components/chainlink/nodeset.md)
-    - [Storage](framework/components/storage.md)
-      - [S3](framework/components/storage/s3.md)
-    - [Chip Ingress Set](framework/components/chipingresset/chip_ingress.md)
-  - [Clients]()
-    - [Chainlink]()
-    - [RPC]()
-    - [Loki]()
+- [Observability Stack](framework/observability/observability_stack.md)
+  - [Overview](framework/observability/observability_stack.md)
+  - [Metrics](framework/observability/metrics.md)
+  - [Logs](framework/observability/logs.md)
+  - [Profiling](framework/observability/profiling.md)
+  - [PostgreSQL](framework/observability/postgresql.md)
+  - [BlockScout](framework/observability/blockscout.md)
+- [Components](framework/components/overview.md)
+  - [Overview](framework/components/overview.md)
+  - [Blockchains](framework/components/blockchains/overview.md)
+    - [EVM](framework/components/blockchains/evm.md)
+    - [Solana](framework/components/blockchains/solana.md)
+    - [Aptos](framework/components/blockchains/aptos.md)
+    - [Sui](framework/components/blockchains/sui.md)
+    - [TRON](framework/components/blockchains/tron.md)
+    - [ZKSync](framework/components/blockchains/zksync.md)
+    - [Ton](framework/components/blockchains/ton.md)
+  - [Storage](framework/components/storage.md)
+    - [S3](framework/components/storage/s3.md)
+  - [Chip Ingress Set](framework/components/chipingresset/chip_ingress.md)
+- [Troubleshooting](framework/components/troubleshooting.md)
 - [Mono Repository Tooling](./monorepo-tools.md)
 - [Testing Maturity Model](framework/testing.md)
-  - [Smoke]()
-  - [Performance]()
-  - [Chaos](./framework/chaos/chaos.md)
+  - [Chaos Testing](./framework/chaos/chaos.md)
   - [Fork Testing](./framework/fork.md)
   - [Fork Testing (Mutating Storage)](./framework/fork_storage.md)
 - [Libraries](./libraries.md)
-  - [Seth](./libs/seth.md)
+  - [Overview](./libraries.md)
   - [WASP](./libs/wasp/overview.md)
     - [Getting started](./libs/wasp/getting_started.md)
     - [First test (RPS test)](./libs/wasp/first_test.md)
@@ -112,45 +101,46 @@
       - [Reuse dashboard components](./libs/wasp/how-to/reuse_dashboard_components.md)
       - [Parallelize load](./libs/wasp/how-to/parallelise_load.md)
       - [Debug Loki errors](./libs/wasp/how-to/debug_loki_errors.md)
-  - [Havoc](./libs/havoc.md)
-  - [K8s Test Runner](k8s-test-runner/k8s-test-runner.md)
+    - [Havoc](./libs/havoc.md)
+    - [Seth](./libs/seth.md)
   - [Sentinel](./libs/sentinel.md)
-
 ---
 
-- [Releasing modules](releasing_modules.md)
+- [Legacy](./legacy.md)
+  - [Overview](./legacy.md)
+  - [CTFv1](lib.md)
+      - [Blockchain](lib/blockchain.md)
+      - [Concurrency](lib/concurrency.md)
+      - [Client](lib/client.md)
+        - [Anvil]()
+        - [AWS Secrets Manager](lib/client/aws_secrets_manager.md)
+        - [Github](lib/client/github.md)
+        - [Grafana](lib/client/grafana.md)
+        - [Kafka](lib/client/kafka.md)
+        - [Loki](lib/client/loki.md)
+        - [MockServer](lib/client/mockserver.md)
+        - [Postgres](lib/client/postgres.md)
+        - [Prometheus](lib/client/prometheus.md)
+      - [Kubernetes](lib/k8s_new/overview.md)
+        - [Creating environments](lib/k8s_new/environments.md)
+        - [Using remote runner](lib/k8s_new/remote_runner.md)
+        - [Passing test secrets](lib/k8s_new/test_secrets.md)
+        - [chain.link labels](lib/k8s/labels.md)
+      - [Kubernetes (legacy docs)](lib/k8s/KUBERNETES.md)
+        - [K8s Remote Run](lib/k8s/REMOTE_RUN.md)
+        - [K8s Tutorial](lib/k8s/TUTORIAL.md)
+      - [Config](lib/config/config.md)
+      - [Docker](lib/docker/overview.md)
+        - [Blockchain nodes](lib/docker/blockchain_nodes.md)
+        - [Chainlink ecosystem](lib/docker/chainlink_ecosystem.md)
+        - [Third party apps]()
+        - [Test helpers](lib/docker/test_helpers.md)
+      - [Logging](lib/logging.md)
+  - [K8s Test Runner](k8s-test-runner/k8s-test-runner.md)
 
 ---
 
-- [CTFv1 (Discouraged)](lib.md)
-  - [Blockchain](lib/blockchain.md)
-  - [Concurrency](lib/concurrency.md)
-  - [Client](lib/client.md)
-    - [Anvil]()
-    - [AWS Secrets Manager](lib/client/aws_secrets_manager.md)
-    - [Github](lib/client/github.md)
-    - [Grafana](lib/client/grafana.md)
-    - [Kafka](lib/client/kafka.md)
-    - [Loki](lib/client/loki.md)
-    - [MockServer](lib/client/mockserver.md)
-    - [Postgres](lib/client/postgres.md)
-    - [Prometheus](lib/client/prometheus.md)
-  - [Kubernetes](lib/k8s_new/overview.md)
-    - [Creating environments](lib/k8s_new/environments.md)
-    - [Using remote runner](lib/k8s_new/remote_runner.md)
-    - [Passing test secrets](lib/k8s_new/test_secrets.md)
-    - [chain.link labels](lib/k8s/labels.md)
-  - [Kubernetes (legacy docs)](lib/k8s/KUBERNETES.md)
-    - [K8s Remote Run](lib/k8s/REMOTE_RUN.md)
-    - [K8s Tutorial](lib/k8s/TUTORIAL.md)
-  - [Config](lib/config/config.md)
-  - [CRIB Connector](lib/crib.md)
-  - [Docker](lib/docker/overview.md)
-    - [Blockchain nodes](lib/docker/blockchain_nodes.md)
-    - [Chainlink ecosystem](lib/docker/chainlink_ecosystem.md)
-    - [Third party apps]()
-    - [Test helpers](lib/docker/test_helpers.md)
-  - [Logging](lib/logging.md)
+- [Releasing modules](releasing_modules.md)
 
 ---
 

book/src/developing.md

@@ -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/chainlink/node.md)
+- Component **must** have documentation under [Components](./framework/components/overview.md), here is an [example](./framework/components/chainlink/nodeset.md)

book/src/framework/nodeset_environment_import.md → book/src/framework/cl_node_keys_import.md

@@ -1,5 +1,6 @@
-# NodeSet Environment (Import Keys)
+# CL Node Keys Import
 
 If your tests are designed to run not just within a Docker environment but also with external infrastructure, and you want to reuse the test logic across different environments or securely store private keys, refer to the example below.
 
 [Import Keys Example](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/examples/myproject/smoke_import_keys_test.go)
+