Skip to content

Commit

Permalink
docs: merge new docs branch into main (#6207)
Browse files Browse the repository at this point in the history
* fix absolute links

* fix links

* Fix link

* Remove docs-publish workflow

---------

Co-authored-by: Edward Huang <[email protected]>
  • Loading branch information
Meschreiber and shorgi authored Oct 16, 2024
1 parent e97ecf7 commit dca22ae
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 32 deletions.
20 changes: 0 additions & 20 deletions .github/workflows/docs-publish.yml

This file was deleted.

2 changes: 1 addition & 1 deletion docs/source/essentials/errors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ if (response.data != null) {
}
```

This is also true when calling `toFlow()` (e.g. with [subscriptions](../essentials/subscription)) and `watch()` (with the [normalized cache](../caching/query-watchers)).
This is also true when calling `toFlow()` (e.g. with [subscriptions](/kotlin/essentials/subscriptions)) and `watch()` (with the [normalized cache](/kotlin/caching/query-watchers)).

```kotlin
apolloClient.subscription(subscription).toFlow().collect { response ->
Expand Down
16 changes: 8 additions & 8 deletions docs/source/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Introduction to Apollo Kotlin
description: A strongly-typed, caching GraphQL client for the JVM, Android, and Kotlin multiplatform.
---

> 📣 **Migration guide:** if you're using Apollo Kotlin 3, see the [migration guide](./migration/4.0/). You can also [view the 3.x docs](https://www.apollographql.com/docs/kotlin/v3).
> 📣 **Migration guide:** if you're using Apollo Kotlin 3, see the [migration guide](/kotlin/migration/4.0/). You can also [view the 3.x docs](https://www.apollographql.com/docs/kotlin/v3).
[Apollo Kotlin](https://github.com/apollographql/apollo-kotlin) is a strongly typed GraphQL client that generates Kotlin models for your GraphQL operations.

Expand Down Expand Up @@ -31,7 +31,7 @@ This library is designed with Android in mind, but you can use it in any Kotlin

## Getting started

If you are new to GraphQL, check out [the tutorial](./tutorial/00-introduction/) that will guide you through building an Android app using Apollo.
If you are new to GraphQL, check out [the tutorial](/kotlin/tutorial/00-introduction/) that will guide you through building an Android app using Apollo.

If you'd like to add Apollo Kotlin to an existing project, follow the steps below.

Expand Down Expand Up @@ -106,9 +106,9 @@ Build your project. This generates a `HeroQuery` class that you can use with an

**To learn more about other Apollo Kotlin APIs:**

* Execute your first [mutation](./essentials/mutations/).
* Handle [custom scalar types](./essentials/custom-scalars/).
* Factor common patterns using [fragments](./essentials/fragments/).
* Execute your first [mutation](/kotlin/essentials/mutations/).
* Handle [custom scalar types](/kotlin/essentials/custom-scalars/).
* Factor common patterns using [fragments](/kotlin/essentials/fragments/).

## Multiplatform

Expand Down Expand Up @@ -160,7 +160,7 @@ As the code generated by Apollo Kotlin doesn't use any reflection, it can safely

A [plugin for Android Studio and IntelliJ](https://plugins.jetbrains.com/plugin/20645-apollo-graphql) is available to help you work with Apollo Kotlin, providing automatic code generation, integration with the [GraphQL IntelliJ Plugin](https://plugins.jetbrains.com/plugin/8097-js-graphql), navigation to GraphQL definitions, migration helpers, and more.

Installation instructions and more information can be found [here](testing/android-studio-plugin).
Installation instructions and more information can be found [here](/kotlin/testing/android-studio-plugin).

## Releases

Expand Down Expand Up @@ -218,7 +218,7 @@ pluginManagement {

The snapshots are updated on each push to `main` and have no retention guarantees.

Weekly snapshots for the Android Studio / IntelliJ plugin [are also available](testing/android-studio-plugin#weekly-snapshots).
Weekly snapshots for the Android Studio / IntelliJ plugin [are also available](/kotlin/testing/android-studio-plugin#weekly-snapshots).

## Previews

Expand Down Expand Up @@ -250,7 +250,7 @@ Previews are published every night 3am UTC time. You can get them by replacing `

## Evolution policy

You can read about our evolution policy in the [dedicated page](essentials/evolution)
You can read about our evolution policy in the [dedicated page](/kotlin/essentials/evolution)

## Contributing

Expand Down
3 changes: 1 addition & 2 deletions docs/source/migration/1.3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -243,8 +243,7 @@ queries, you will now have to use operationOutput.json.
Idling Resources integration is moved to AndroidX! This is a potential breaking change for users who has not migrated to AndroidX yet. If
you haven't you can still use the 1.2.x version in your test code.
The artifact is also renamed to make its intention more obvious. Documentation for idling resource can be found
[here](../testing/ui-tests/)
The artifact is also renamed to make its intention more obvious.
```groovy title="build.gradle"
// Replace:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/migration/3.0.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -800,7 +800,7 @@ error occurred, and you can react to this by reconnecting with `reopenWhen`.

If you were previously using `subscriptionConnectionParams` to authenticate your subscription, you can now use
`wsProtocol` with a `connectionPayload` passed inside the `SubscriptionWsProtocol.Factory`. More information can be
found in [Authenticating your WebSockets](../advanced/authentication.mdx#authenticating-your-websockets).
found in [Authenticating your WebSockets](/kotlin/advanced/authentication#authenticating-your-websockets).

If you feel some API is missing from `SubscriptionManager`,
please [reach out](https://github.com/apollographql/apollo-kotlin/issues/new?assignees=&labels=%3Asparkles%3A+Type%3A+Feature&template=feature_request.md&title=)
Expand Down

0 comments on commit dca22ae

Please sign in to comment.