Skip to content

New README info architecture and content #6561

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

Jump to bottom
Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

New README info architecture and content #6561

wants to merge 8 commits into from
+78 −29

Conversation

bignimbus
Copy link
Contributor

@bignimbus bignimbus commented Jun 6, 2025 •
edited
Loading

TODO

Before marking as ready for review:

  • Update other READMEs
  • Verify links
  • Maybe link out to Galaxy projects?

@svc-apollo-docs
Copy link
Collaborator

svc-apollo-docs commented Jun 6, 2025 •
edited
Loading

✅ Docs preview has no changes

The preview was not built because there were no changes.

Build ID: 5477256c5cddd7d3409db00d

@bignimbus bignimbus requested a review from a team June 6, 2025 16:38
BoD
BoD reviewed Jun 6, 2025
View reviewed changes
martinbonnin
martinbonnin reviewed Jun 6, 2025
View reviewed changes
README.md Outdated
<p>
<a href="https://www.apollographql.com/"><img src="https://raw.githubusercontent.com/apollographql/apollo-client-devtools/a7147d7db5e29b28224821bf238ba8e3a2fdf904/assets/apollo-wordmark.svg" height="100" alt="Apollo Client"></a>
</p>
➡️ [**Get Started with Apollo Kotlin →**](https://www.apollographql.com/docs/kotlin?utm_source=github&utm_medium=apollographql_apollo-kotlin&utm_campaign=readme)
Copy link
Contributor

Choose a reason for hiding this comment

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

This looks a bit out of place. Maybe move it to the "quick start" section?

README.md
}
}
```

Copy link
Contributor

Choose a reason for hiding this comment

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

I have the feeling this either too short or too long. If we really want to include a quick start, it feels like it should explain how to write a query and use the generated models. A .gif like SQLDelight would do wonders

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed the instructions and linked out to the docs for now. Gif would be awesome as a follow up!

bignimbus and others added 6 commits June 6, 2025 13:40
@bignimbus @BoD
Update README.md
e6ef640 
Co-authored-by: Benoit 'BoD' Lubek <BoD@JRAF.org>
@bignimbus @martinbonnin
Update README.md
fe3b050 
Co-authored-by: Martin Bonnin <martin@mbonnin.net>
@bignimbus @martinbonnin
Update README.md
957af5d 
Co-authored-by: Martin Bonnin <martin@mbonnin.net>
@bignimbus @martinbonnin
Update README.md
ca06140 
Co-authored-by: Martin Bonnin <martin@mbonnin.net>
@bignimbus
Update README.md
d379d28
@bignimbus
Update README.md (code review)
da25268
@apollo-librarian
Copy link

apollo-librarian bot commented Jul 3, 2025 •
edited
Loading

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

0 new, 15 changed, 1 removed 
* (developer-tools)/kotlin/v5/index.mdx
* (developer-tools)/kotlin/v5/advanced/apollo-ast.mdx
* (developer-tools)/kotlin/v5/advanced/compiler-plugins.mdx
* (developer-tools)/kotlin/v5/advanced/no-runtime.mdx
* (developer-tools)/kotlin/v5/advanced/persisted-queries.mdx
* (developer-tools)/kotlin/v5/advanced/plugin-configuration.mdx
* (developer-tools)/kotlin/v5/caching/declarative-ids.mdx
* (developer-tools)/kotlin/v5/caching/http-cache.mdx
* (developer-tools)/kotlin/v5/caching/normalized-cache.mdx
* (developer-tools)/kotlin/v5/caching/programmatic-ids.mdx
* (developer-tools)/kotlin/v5/essentials/modules.mdx
* (developer-tools)/kotlin/v5/testing/android-studio-plugin.mdx
* (developer-tools)/kotlin/v5/testing/apollo-debug-server.mdx
* (developer-tools)/kotlin/v5/testing/mocking-graphql-responses.mdx
* (developer-tools)/kotlin/v5/_sidebar.yaml
- (developer-tools)/kotlin/v5/migration/5.0.mdx

Build ID: 5843114893df1b0ddafff66f

URL: https://www.apollographql.com/docs/deploy-preview/5843114893df1b0ddafff66f

@bignimbus bignimbus marked this pull request as ready for review July 3, 2025 16:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BoD BoD BoD left review comments

@martinbonnin martinbonnin martinbonnin left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@bignimbus @svc-apollo-docs @BoD @martinbonnin