Skip to content

Commit 6db8da9

Browse files
committed
docs(pems_data): link to reference sections
1 parent e7c6a84 commit 6db8da9

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/development/pems_data/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ When running locally in the devcontainer, a `redis` service is started by Compos
3030

3131
The library is built around a few core components that work together to provide a simple data access experience.
3232

33-
- `ServiceFactory`: This is the primary entry point for using the library. It is a factory class that instantiates and wires together all the necessary dependencies, such as the data sources and caching clients.
33+
- [`ServiceFactory`](./reference/service-factory.md): This is the primary entry point for using the library. It is a factory class that instantiates and wires together all the necessary dependencies, such as the data sources and caching clients.
3434

35-
- **Services**: Services offer a high-level API for fetching specific, business-relevant data. For example, the `StationsService` has methods to get all station metadata for a given district or to retrieve 5-minute aggregated data for a specific station.
35+
- [**Services**](./reference/services.md): Services offer a high-level API for fetching specific, business-relevant data. For example, the `StationsService` has methods to get all station metadata for a given district or to retrieve 5-minute aggregated data for a specific station.
3636

37-
- **Caching layer**: To minimize latency and load on the data source, the library uses a caching decorator by default. When a data request is made, this layer first checks the Redis cache for the requested data. If the data is not found (a cache miss), it retrieves the data from the underlying S3 source and stores it in the cache for future requests.
37+
- [**Caching layer**](./reference/caching-layer.md): To minimize latency and load on the data source, the library uses a caching decorator by default. When a data request is made, this layer first checks the Redis cache for the requested data. If the data is not found (a cache miss), it retrieves the data from the underlying S3 source and stores it in the cache for future requests.
3838

39-
- **Data sources**: The underlying data source reads data directly from Parquet files stored in the Caltrans S3 bucket.
39+
- [**Data sources**](./reference/data-sources.md): The underlying data source reads data directly from Parquet files stored in the Caltrans S3 bucket.
4040

4141
## Basic usage
4242

0 commit comments

Comments
 (0)