Skip to content

docs: Remove screenshots of Studio since an example is linked #843

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.

Sign up for GitHub

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

Merged
mabuyo merged 4 commits into from
Nov 10, 2025
Merged

docs: Remove screenshots of Studio since an example is linked #843

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5e02361
Remove screenshot from instructions that link to a live example
jcaudle Nov 8, 2025
a4de3c0
Update tutorial for downloading GraphQL schema
jcaudle Nov 8, 2025
b5f80f2
Delete docs/source/screenshot/studio-starwarsapi-download.png
jcaudle Nov 8, 2025
94b2c22
fix: capitalization + punctuation
mabuyo Nov 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions docs/source/code-generation/downloading-schema.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,7 @@

In the SDL view of the Schema tab of Apollo Studio there is a drop-down menu where you can download the linked schema in SDL or JSON format.

Below is a screenshot showing the [StarWars GraphQL API](https://studio.apollographql.com/public/star-wars-swapi/home?variant=current) in an Apollo Studio [public example](https://studio.apollographql.com/public/star-wars-swapi/schema/sdl?variant=current). On the right-hand side you can see the drop-down allowing downloads of both formats.

<img class="screenshot" src="../screenshot/studio-starwarsapi-download.png" alt="Where to download a schema from Apollo Studio" />
You can visit this [public example](https://studio.apollographql.com/public/star-wars-swapi/schema/sdl?variant=current) of Apollo Studio for a [StarWars GraphQL API](https://studio.apollographql.com/public/star-wars-swapi/home?variant=current). On the right-hand side, you can see the drop-down allowing downloads of both formats.

Check warning on line 17 in docs/source/code-generation/downloading-schema.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/code-generation/downloading-schema.mdx#L17 

Use descriptive link text instead of vague phrases like 'this example'. Avoid directional language (e.g., 'right-hand side') when describing a user interface.

```suggestion
For an example, see the public [Star Wars GraphQL API](https://studio.apollographql.com/public/star-wars-swapi/home?variant=current) in Apollo Studio. In the [schema view](https://studio.apollographql.com/public/star-wars-swapi/schema/sdl?variant=current), a dropdown menu enables you to download the schema in either format.
```

Please see the [documentation](https://www.apollographql.com/docs/studio/) for further details on how to use Apollo Studio.

Expand Down
Binary file removed docs/source/screenshot/studio-starwarsapi-download.png
View file
Open in desktop
Binary file not shown.
2 changes: 0 additions & 2 deletions docs/source/tutorial/codegen-getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ cd ios-code-gen-example

We'll use the [StarWars GraphQL API](https://studio.apollographql.com/public/star-wars-swapi/home?variant=current) for this example. You can check this schema out using [Apollo Studio](https://studio.apollographql.com/public/star-wars-swapi/schema/sdl?variant=current).

<img class="screenshot" src="../screenshot/studio-starwarsapi-download.png" alt="Where to download a schema from Apollo Studio" />

On the right-hand side in Apollo Studio find the drop-down to download the schema, shown in the above screenshot. Apollo Studio supports both `JSON` or `Raw` formats. For this tutorial select `Raw` which downloads the GraphQL schema in the Schema Definition Language (SDL) format.

Clicking `Raw` will download a file named `[email protected]`.
Expand Down
Loading