Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken links in docs #2180

Merged
merged 2 commits into from
May 13, 2024
Merged

Fix broken links in docs #2180

merged 2 commits into from
May 13, 2024

Conversation

Pask423
Copy link
Contributor

@Pask423 Pask423 commented May 13, 2024

closes #1419

@Pask423 Pask423 requested review from adamw and kciesielski May 13, 2024 07:39
@@ -277,6 +277,7 @@ class MyCustomBackendHttpTest extends HttpTest[Future] {
}
```

[//]: # (TO REVIEWER last update 6 years ago maybe we have sth newer)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's just remove it then

@@ -35,6 +35,6 @@ Please note that:

Instead, all custom timeout configuration should be done by creating a `org.http4s.client.Client[F]`, using e.g. `org.http4s.client.blaze.BlazeClientBuilder[F]` and passing it to the appropriate method of the `Http4sBackend` object.

The backend supports streaming using fs2. For usage details, see the documentation on [streaming using fs2](fs2.md#streaming).
The backend supports streaming using fs2. For usage details, see the documentation on [streaming using fs2](https://sttp.softwaremill.com/en/latest/backends/fs2.html#streaming).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe let's just keep a link to fs2.md to avoid hard-coding links to our own docs

docs/index.md Outdated
@@ -48,7 +48,10 @@ sttp is a family of Scala HTTP-related projects, and currently includes:
Third party projects:

* [sttp-oauth2](https://github.com/ocadotechnology/sttp-oauth2): OAuth2 client library for Scala

[//]: # (* TO REVIEWER repo archived by owner)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's remove this then

@adamw adamw merged commit 12269ce into master May 13, 2024
18 checks passed
@adamw adamw deleted the doc-audit branch May 13, 2024 13:53
@adamw
Copy link
Member

adamw commented May 13, 2024

Thanks :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sttp documentation audit
2 participants