Skip to content

Commit 44257e8

Browse files
tirumerlazeljkoX
andauthored
chore: plat-7575 Docs fixes (#153) (#154)
* chore: adopt docs for netlify deployment * chore: fixes docs sections * chore: revert svg change * chore: improvements Co-authored-by: Zeljko <zeljko89markovic@gmail.com>
1 parent 8d1ae27 commit 44257e8

2 files changed

Lines changed: 13 additions & 4 deletions

File tree

docs/modules/ROOT/nav.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,4 @@
22
* xref:quickstart.adoc[Quickstart]
33
* xref:api_reference.adoc[API Reference]
44
* xref:structure.adoc[Project Structure]
5-
* link:rust_docs/doc/openzeppelin_relayer/index.html[Technical Rust Documentation]
65
* xref:roadmap.adoc[Project Roadmap]

docs/modules/ROOT/pages/index.adoc

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,15 @@
33
= OpenZeppelin Relayer
44
:description: User guide for setting up and configuring OpenZeppelin Relayer.
55

6+
== Overview
7+
68
CAUTION: This software is in alpha stage. Use in production environments at your own risk.
79

810
OpenZeppelin Relayer is a service that provides infrastructure to relay transactions to the EVM & Non-EVM networks. It is designed to be used as a backend for dApps that need to interact with these networks.
911

10-
**Features**
12+
13+
== Features
14+
1115
- **Multi-Chain Support**: Interact with multiple blockchain networks, including Solana and EVM-based chains.
1216
- **Transaction Relaying**: Submit transactions to supported blockchain networks efficiently.
1317
- **Transaction Signing**: Securely sign transactions using configurable key management.
@@ -21,7 +25,8 @@ OpenZeppelin Relayer is a service that provides infrastructure to relay transact
2125
- **Metrics and Observability**: Monitor application performance using Prometheus and Grafana.
2226
- **Docker Support**: Deploy the relayer using Docker for both development and production environments.
2327

24-
**Supported Networks**
28+
29+
== Supported Networks
2530

2631
- Solana
2732
- EVM (Basic support for Ethereum and other EVM-compatible chains):
@@ -42,6 +47,7 @@ To get started immediately, see xref:quickstart.adoc[Quickstart].
4247

4348
== Technical Overview
4449

50+
4551
[mermaid,width=100%]
4652
....
4753
%%{init: {
@@ -606,6 +612,7 @@ Available configuration fields
606612
==== 2. Notifications
607613

608614
* `notifications` array, which should contain, at least, one valid configuration:
615+
609616
[source,json]
610617
----
611618
"notifications": [
@@ -649,6 +656,7 @@ Available configuration fields
649656
==== 3. Relayers
650657

651658
* `relayers` array, containing at least one valid relayer configuration:
659+
652660
[source,json]
653661
----
654662
"relayers": [
@@ -815,7 +823,8 @@ Policies
815823

816824
Full `config/config.json` example with evm and solana relayers definitions using keystore signer:
817825

818-
```json
826+
[source,json]
827+
----
819828
{
820829
"relayers": [
821830
{
@@ -882,6 +891,7 @@ Full `config/config.json` example with evm and solana relayers definitions using
882891
]
883892
}
884893
```
894+
----
885895

886896
=== RPC URL Configuration
887897

0 commit comments

Comments
 (0)