Skip to content

Commit c627756

Browse files
authored
docs: fix broken links to config examples (#530)
1 parent a0d719f commit c627756

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77
[![GitHub Release](https://img.shields.io/github/v/release/graphprotocol/indexer-rs?filter=indexer-service-rs-*)](https://github.com/graphprotocol/indexer-rs/releases?q=indexer-service-rs)
88
[![GitHub Release](https://img.shields.io/github/v/release/graphprotocol/indexer-rs?filter=indexer-tap-agent-*)](https://github.com/graphprotocol/indexer-rs/releases?q=indexer-tap-agent)
99

10-
A Rust implementation for The Graph
11-
[indexer-service-ts](https://github.com/graphprotocol/indexer/tree/main/packages/indexer-service)
12-
to provide subgraph service as an Indexer,
13-
integrated with [TAP](https://github.com/semiotic-ai/timeline-aggregation-protocol)
10+
A Rust implementation for The Graph
11+
[indexer-service-ts](https://github.com/graphprotocol/indexer/tree/main/packages/indexer-service)
12+
to provide subgraph service as an Indexer,
13+
integrated with [TAP](https://github.com/semiotic-ai/timeline-aggregation-protocol)
1414
which is a fast, efficient, and trustless unidirectional micro-payments system.
1515

16-
---
16+
---
1717
## Getting Started
1818

1919
This section provides guidance for building, configuring, and running `indexer-service-rs` and `indexer-tap-agent`.
@@ -87,7 +87,7 @@ git clone https://github.com/graphprotocol/indexer-rs.git && cd indexer-rs
8787
### Configuration
8888

8989
The services require a configuration file provided through the `--config` flag during startup. A minimal example configuration is available at:
90-
- [Minimal Configuration Template](config/minimal-config-example.toml)
90+
- [Minimal Configuration Template](crates/config/minimal-config-example.toml)
9191

9292
#### Steps:
9393
1. **Edit the Configuration:**
@@ -104,21 +104,21 @@ export INDEXER_SERVICE_SUBGRAPHS__NETWORK__QUERY_URL=<value>
104104
- **Indexer Service:**
105105

106106
```bash
107-
target/release/indexer-service-rs --config config/minimal-config-example.toml
107+
target/release/indexer-service-rs --config crates/config/minimal-config-example.toml
108108
```
109109

110110
- **TAP Agent:**
111111

112112
```bash
113-
target/release/indexer-tap-agent --config config/minimal-config-example.toml
113+
target/release/indexer-tap-agent --config crates/config/minimal-config-example.toml
114114
```
115115

116116
## Configuration
117117

118118
All configuration is managed through a TOML file. Below are examples of configuration templates to help you get started:
119119

120-
- [Minimal Configuration Template (Recommended)](config/minimal-config-example.toml): A minimal setup with only the essential configuration options.
121-
- [Maximal Configuration Template (Not Recommended)](config/maximal-config-example.toml): Includes all possible options, but some settings may be dangerous or unsuitable for production.
120+
- [Minimal Configuration Template (Recommended)](crates/config/minimal-config-example.toml): A minimal setup with only the essential configuration options.
121+
- [Maximal Configuration Template (Not Recommended)](crates/config/maximal-config-example.toml): Includes all possible options, but some settings may be dangerous or unsuitable for production.
122122

123123
If you are migrating from an older stack, use the [Migration Configuration Guide](./docs/migration-config/README.md) for detailed instructions.
124124

@@ -151,7 +151,7 @@ By following these steps, you can take advantage of new features and improvement
151151

152152
## Contributing
153153

154-
We welcome contributions to `indexer-rs`!
154+
We welcome contributions to `indexer-rs`!
155155

156156
### How to Contribute
157157
- Read the [Contributions Guide](./CONTRIBUTORS.md) for detailed guidelines.
@@ -165,7 +165,7 @@ Contributions can include:
165165
- Documentation improvements
166166
- Performance optimizations
167167

168-
Feel free to suggest enhancements or report issues in the project repository.
168+
Feel free to suggest enhancements or report issues in the project repository.
169169

170170

171171
## Implementation Details
@@ -176,7 +176,7 @@ The Subgraph Service is an [axum](https://crates.io/crates/axum)-based web serve
176176

177177
#### Key Features
178178
- **Middleware-Based Checks:** All validation and processing are performed through middleware, enabling modular and reusable components.
179-
- **TAP Integration:**
179+
- **TAP Integration:**
180180
- TAP receipts are processed by the `tap-middleware`, where they undergo various [checks](./crates/service/src/tap/checks/).
181181
- Valid receipts are stored in the database, later aggregated into RAVs (Redeemable Aggregate Values) by the [tap-agent](#indexer-tap-agent).
182182
- **Router Implementation:**
@@ -200,7 +200,7 @@ The TAP Agent is an actor-based system powered by [ractor](https://crates.io/cra
200200

201201
2. **Actor System:**
202202
- The TAP Agent operates using three main actor groups:
203-
- **SenderAccountManager:**
203+
- **SenderAccountManager:**
204204
- Monitors the indexer's escrow accounts.
205205
- Handles receipt routing to the appropriate `SenderAllocation`.
206206
- Kills the application if the database connection is lost.

0 commit comments

Comments
 (0)