Skip to content

Commit cb442bb

Browse files
committed
chore: fixed links and removed versioned-link component
1 parent c444fd9 commit cb442bb

32 files changed

Lines changed: 245 additions & 207 deletions

content/monitor/1.0.x/architecture.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ The architecture includes several resilience mechanisms:
293293
* ***Retry Logic***: Notification delivery includes configurable retry mechanisms for transient failures
294294
* ***Graceful Degradation***: Individual component failures don’t cascade to the entire system
295295

296-
For detailed information about RPC logic and network communication, see the [RPC section](/monitor/rpc).
296+
For detailed information about RPC logic and network communication, see the [RPC section](/monitor/1.0.x/rpc).
297297

298298
## Configuration Architecture
299299

@@ -316,7 +316,7 @@ The system implements comprehensive validation:
316316

317317

318318

319-
For configuration examples and best practices, see the [Configuration Guidelines](/monitor#configuration-guidelines) section in the user documentation.
319+
For configuration examples and best practices, see the [Configuration Guidelines](/monitor/1.0.x#configuration-guidelines) section in the user documentation.
320320

321321

322322
## Extensibility Points
@@ -355,8 +355,8 @@ The system implements several security measures:
355355

356356
## Related Documentation
357357

358-
For detailed information about the project structure, source code organization, and development resources, see the [Project Structure](/monitor/project-structure) guide.
358+
For detailed information about the project structure, source code organization, and development resources, see the [Project Structure](/monitor/1.0.x/project-structure) guide.
359359

360-
For information about RPC logic and network communication, see the [RPC section](/monitor/rpc).
360+
For information about RPC logic and network communication, see the [RPC section](/monitor/1.0.x/rpc).
361361

362-
For configuration examples and best practices, see the [Configuration Guidelines](/monitor#configuration-guidelines) section in the user documentation.
362+
For configuration examples and best practices, see the [Configuration Guidelines](/monitor/1.0.x#configuration-guidelines) section in the user documentation.

content/monitor/1.0.x/contribution.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ RUST_TEST_THREADS=1 cargo test
200200
* Ensure all tests pass before submitting
201201
* Maintain or improve code coverage
202202

203-
For detailed testing information, see the [Testing Guide](/monitor/testing).
203+
For detailed testing information, see the [Testing Guide](/monitor/1.0.x/testing).
204204

205205
### Commit Message Format
206206

content/monitor/1.0.x/index.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ In the rapidly evolving world of blockchain technology, effective monitoring is
3131

3232

3333

34-
To get started immediately, see [Quickstart](/monitor/quickstart).
34+
To get started immediately, see [Quickstart](/monitor/1.0.x/quickstart).
3535

3636

3737
## Installation
@@ -658,7 +658,7 @@ A Trigger defines actions to take when monitored conditions are met. Triggers ca
658658
| `**arguments**` | `Array[String]` | The arguments of the script (optional). |
659659
| `**timeout_ms**` | `Number` | The timeout of the script is important to avoid infinite loops during the execution. If the script takes longer than the timeout, it will be killed. |
660660

661-
For more information about custom scripts, see [Custom Scripts Section](/monitor/scripts).
661+
For more information about custom scripts, see [Custom Scripts Section](/monitor/1.0.x/scripts).
662662

663663

664664

@@ -1206,7 +1206,7 @@ You can find the contract specification through Stellar contract explorer tool.
12061206

12071207
Custom filters allow you to create sophisticated filtering logic for processing monitor matches. These filters act as additional validation layers that determine whether a match should trigger the execution of a trigger or not.
12081208

1209-
For more information about custom scripts, see [Custom Scripts Section](/monitor/scripts).
1209+
For more information about custom scripts, see [Custom Scripts Section](/monitor/1.0.x/scripts).
12101210

12111211

12121212

@@ -1397,21 +1397,21 @@ Specific Block Mode requires both parameters:
13971397

13981398
## Error Handling
13991399

1400-
The monitor implements a comprehensive error handling system with rich context and tracing capabilities. For detailed information about error handling, see [Error Handling Guide](/monitor/error).
1400+
The monitor implements a comprehensive error handling system with rich context and tracing capabilities. For detailed information about error handling, see [Error Handling Guide](/monitor/1.0.x/error).
14011401

14021402
## Important Considerations
14031403

14041404
### Performance Considerations
14051405

14061406
* Monitor performance depends on network congestion and RPC endpoint reliability.
1407-
* View the [list of RPC calls](/monitor/rpc#list-of-rpc-calls) made by the monitor.
1407+
* View the [list of RPC calls](/monitor/1.0.x/rpc#list-of-rpc-calls) made by the monitor.
14081408
* The `max_past_blocks` configuration is critical:
14091409
* Calculate as: `(cron_interval_ms/block_time_ms) + confirmation_blocks + 1` (defaults to this calculation if not specified).
14101410
* Example for 1-minute Ethereum cron: `(60000/12000) + 12 + 1 = 18 blocks`.
14111411
* Too low settings may result in missed blocks.
14121412
* Trigger conditions are executed sequentially based on their position in the trigger conditions array. Proper execution also depends on the number of available file descriptors on your system. To ensure optimal performance, it is recommended to increase the limit for open file descriptors to at least 2048 or higher. On Unix-based systems you can check the current limit by running `ulimit -n` and _***temporarily***_ increase it with `ulimit -n 2048`.
14131413
* Since scripts are loaded at startup, any modifications to script files require restarting the monitor to take effect.
1414-
* See performance considerations about custom scripts [here](/monitor/scripts#performance-considerations).
1414+
* See performance considerations about custom scripts [here](/monitor/1.0.x/scripts#performance-considerations).
14151415

14161416
### Notification Considerations
14171417

content/monitor/1.0.x/project-structure.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,4 +203,4 @@ The project includes Docker configurations for different environments:
203203

204204

205205

206-
For detailed information about running the monitor in containers, see the Docker deployment [section](/monitor#docker-installation) in the user documentation.
206+
For detailed information about running the monitor in containers, see the Docker deployment [section](/monitor/1.0.x#docker-installation) in the user documentation.

content/monitor/1.0.x/quickstart.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ Copy the example environment file and customize it:
153153
cp .env.example .env
154154
```
155155

156-
For detailed configuration options, see [Basic Configuration](/monitor#basic-configuration).
156+
For detailed configuration options, see [Basic Configuration](/monitor/1.0.x#basic-configuration).
157157

158158
## Practical Examples
159159

@@ -587,13 +587,13 @@ Now that you have OpenZeppelin Monitor running, here are some suggestions for wh
587587

588588
### Testing and Validation
589589

590-
* [Test your configuration](/monitor#testing-your-configuration) against specific block numbers
590+
* [Test your configuration](/monitor/1.0.x#testing-your-configuration) against specific block numbers
591591
* Verify your RPC endpoints are working correctly
592592
* Test notification channels with small transactions
593593

594594
### Security and Best Practices
595595

596-
* [Configure secure secret management](/monitor#secret-management) for sensitive data
596+
* [Configure secure secret management](/monitor/1.0.x#secret-management) for sensitive data
597597
* Use environment variables or Hashicorp Cloud Vault for credentials
598598
* Regularly update your RPC endpoints and monitor configurations
599599

@@ -606,7 +606,7 @@ Now that you have OpenZeppelin Monitor running, here are some suggestions for wh
606606
### Getting Help
607607

608608
* Check the [GitHub Issues](https://github.com/OpenZeppelin/openzeppelin-monitor/issues) for known problems
609-
* Review the [User Documentation](/monitor) for detailed configuration options
609+
* Review the [User Documentation](/monitor/1.0.x) for detailed configuration options
610610
* Join the OpenZeppelin community for support
611611

612612

content/monitor/1.0.x/scripts.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -434,7 +434,7 @@ This examples script filters EVM transactions based on their block number:
434434
435435
### Integration
436436
437-
Integrate your custom filter script with the monitor by following the [configuration guidelines](/monitor#trigger-conditions-custom-filters).
437+
Integrate your custom filter script with the monitor by following the [configuration guidelines](/monitor/1.0.x#trigger-conditions-custom-filters).
438438
439439
440440
@@ -599,7 +599,7 @@ This examples demonstrates how to:
599599
600600
### Integration
601601
602-
Integrate your custom notification script with the triggers by following the [configuration guidelines](/monitor#custom-script-notifications).
602+
Integrate your custom notification script with the triggers by following the [configuration guidelines](/monitor/1.0.x#custom-script-notifications).
603603
604604
## Performance Considerations
605605

content/monitor/architecture.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ The architecture includes several resilience mechanisms:
317317
* ***Retry Logic***: Notification delivery includes configurable retry mechanisms for transient failures
318318
* ***Graceful Degradation***: Individual component failures don’t cascade to the entire system
319319

320-
For detailed information about RPC logic and network communication, see the [RPC section](rpc).
320+
For detailed information about RPC logic and network communication, see the [RPC section](/monitor/rpc).
321321

322322
## Configuration Architecture
323323

@@ -379,8 +379,8 @@ The system implements several security measures:
379379

380380
## Related Documentation
381381

382-
For detailed information about the project structure, source code organization, and development resources, see the [Project Structure](project-structure) guide.
382+
For detailed information about the project structure, source code organization, and development resources, see the [Project Structure](/monitor/project-structure) guide.
383383

384-
For information about RPC logic and network communication, see the [RPC section](rpc).
384+
For information about RPC logic and network communication, see the [RPC section](/monitor/rpc).
385385

386386
For configuration examples and best practices, see the [Configuration Guidelines](#configuration-guidelines) section in the user documentation.

content/monitor/contribution.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ RUST_TEST_THREADS=1 cargo test
232232
* Ensure all tests pass before submitting
233233
* Maintain or improve code coverage
234234

235-
For detailed testing information, see the [Testing Guide](testing).
235+
For detailed testing information, see the [Testing Guide](/monitor/testing).
236236

237237
### Commit Message Format
238238

content/monitor/index.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ In the rapidly evolving world of blockchain technology, effective monitoring is
3232
<Callout>
3333

3434

35-
To get started immediately, see [Quickstart](quickstart).
35+
To get started immediately, see [Quickstart](/monitor/quickstart).
3636

3737
</Callout>
3838

@@ -693,7 +693,7 @@ A Trigger defines actions to take when monitored conditions are met. Triggers ca
693693
| `**arguments**` | `Array[String]` | The arguments of the script (optional). |
694694
| `**timeout_ms**` | `Number` | The timeout of the script is important to avoid infinite loops during the execution. If the script takes longer than the timeout, it will be killed. |
695695

696-
For more information about custom scripts, see [Custom Scripts Section](scripts).
696+
For more information about custom scripts, see [Custom Scripts Section](/monitor/scripts).
697697

698698

699699

@@ -1301,7 +1301,7 @@ You can find the contract specification through Stellar contract explorer tool.
13011301

13021302
Custom filters allow you to create sophisticated filtering logic for processing monitor matches. These filters act as additional validation layers that determine whether a match should trigger the execution of a trigger or not.
13031303

1304-
For more information about custom scripts, see [Custom Scripts Section](scripts).
1304+
For more information about custom scripts, see [Custom Scripts Section](/monitor/scripts).
13051305

13061306

13071307

@@ -1492,21 +1492,21 @@ Specific Block Mode requires both parameters:
14921492

14931493
## Error Handling
14941494

1495-
The monitor implements a comprehensive error handling system with rich context and tracing capabilities. For detailed information about error handling, see [Error Handling Guide](error).
1495+
The monitor implements a comprehensive error handling system with rich context and tracing capabilities. For detailed information about error handling, see [Error Handling Guide](/monitor/error).
14961496

14971497
## Important Considerations
14981498

14991499
### Performance Considerations
15001500

15011501
* Monitor performance depends on network congestion and RPC endpoint reliability.
1502-
* View the [list of RPC calls](rpc#list-of-rpc-calls) made by the monitor.
1502+
* View the [list of RPC calls](/monitor/rpc#list-of-rpc-calls) made by the monitor.
15031503
* The `max_past_blocks` configuration is critical:
15041504
* Calculate as: `(cron_interval_ms/block_time_ms) + confirmation_blocks + 1` (defaults to this calculation if not specified).
15051505
* Example for 1-minute Ethereum cron: `(60000/12000) + 12 + 1 = 18 blocks`.
15061506
* Too low settings may result in missed blocks.
15071507
* Trigger conditions are executed sequentially based on their position in the trigger conditions array. Proper execution also depends on the number of available file descriptors on your system. To ensure optimal performance, it is recommended to increase the limit for open file descriptors to at least 2048 or higher. On Unix-based systems you can check the current limit by running `ulimit -n` and _***temporarily***_ increase it with `ulimit -n 2048`.
15081508
* Since scripts are loaded at startup, any modifications to script files require restarting the monitor to take effect.
1509-
* See performance considerations about custom scripts [here](scripts#performance-considerations).
1509+
* See performance considerations about custom scripts [here](/monitor/scripts#performance-considerations).
15101510

15111511
### Notification Considerations
15121512

content/monitor/project-structure.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -205,5 +205,4 @@ The project includes Docker configurations for different environments:
205205

206206

207207

208-
For detailed information about running the monitor in containers, see the Docker deployment [section](docker-installation) in the user documentation.
209-
208+
For detailed information about running the monitor in containers, see the Docker deployment [section](/monitor#docker-installation) in the user documentation.

0 commit comments

Comments
 (0)