Skip to content

Commit

Permalink
docs: Update S2 doc links (#126)
Browse files Browse the repository at this point in the history
Signed-off-by: Vaibhav Rabber <[email protected]>
  • Loading branch information
vrongmeal authored Dec 20, 2024
1 parent e63e037 commit b78c44e
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
</div>

The Rust SDK provides ergonomic wrappers and utilities to interact with the
[S2 API](https://s2.dev/docs/interface/grpc-api).
[S2 API](https://s2.dev/docs/interface/grpc).

## Getting started

Expand Down
10 changes: 7 additions & 3 deletions src/client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@
//! from the basin endpoint creating a new connection each time the request is
//! sent. See [`S2Endpoints`].
//!
//! [AccountService]: https://s2.dev/docs/interface/grpc-api#accountservice
//! [BasinService]: https://s2.dev/docs/interface/grpc-api#basinservice
//! [StreamService]: https://s2.dev/docs/interface/grpc-api#streamservice
//! [AccountService]: https://s2.dev/docs/interface/grpc#accountservice
//! [BasinService]: https://s2.dev/docs/interface/grpc#basinservice
//! [StreamService]: https://s2.dev/docs/interface/grpc#streamservice
//! [s2.dev]: https://s2.dev/dashboard
use std::{env::VarError, fmt::Display, str::FromStr, time::Duration};
Expand Down Expand Up @@ -122,6 +122,10 @@ pub enum BasinEndpoint {
}

/// Endpoints for the S2 environment.
///
/// You can find the S2 endpoints in our [documentation].
///
/// [documentation]: https://s2.dev/docs/interface/endpoints
#[derive(Debug, Clone)]
pub struct S2Endpoints {
/// Used by `AccountService` requests.
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Rust SDK for S2.
The Rust SDK provides ergonomic wrappers and utilities to interact with the
[S2 API](https://s2.dev/docs/interface/grpc-api).
[S2 API](https://s2.dev/docs/interface/grpc).
# Getting started
Expand Down

0 comments on commit b78c44e

Please sign in to comment.