iOS 1.0 Release Documentation Updates

[jpvajda]

Description

As part of our GA release of iOS 1.0 we will need to do a pretty large update to our iOS client documentation in order to document the new code gen capabilities as well as re-structure the documentation for a better documentation user experience. Most of the iOS documentation will need updating.

Below are some general tasks we need to consider.

Docs Tasks

• Review our current iOS docs and consider impacts of v1
• Determine what approach we will take to completing the documentation updates. Should we take a first pass through the docs updates and have them provide feedback? Or do they want to take the lead on the first pass?

Discuss with the Apollo Docs Team if:

• They have opinions on the formatting and organization structure of the V1 docs.
• Determine if they want to provide an outline or structure of navigation for the v1 docs. Structure can come after based on what content is available.
• Consider if we'd benefit from a migration to v1 doc Similar to Kotlin. Added to TODOs
• Since new codegen capabilities are a significant part of this release, consider how that should be documented.

Documentation TODOs

• ApolloAPI.Object.cacheKeyProvider: Add reference to cache key computation usage guide (once written)
• ApolloAPI.CustomScalarType: Add reference to custom scalar usage guide (once written)
• Add better usage examples for ApolloAPI.GraphQLEnum
• Add better usage examples for ApolloAPI.GraphQLNullable
• Add better usage examples for Custom Scalars
• Complete Migration Guide and Project Configuration Documentation #2698
• Replace codegen workflow recommendation of Apollo CLI with Swift scripting #1957
• How to stub and mock generated code models (iOS 1.0 Release Documentation Updates #2344 (comment))

[jpvajda]

@rkoron007 said we can chat about these docs needs soon, and I suggested we provide her team an outline of what we think will need to change, I'll setup some time for all of us to chat in Mid July

[kimdv]

Hi!

A little wish from me, some documentation on how to stub and mock the different parts would be nice. 👏
https://community.apollographql.com/t/mocking-apolloclientprotocol-in-ios-sdk-beta-1/3920

[jpvajda]

@kimdv Good suggestion! We do accept PRs for our documentation, if you had some time and wanted to contribute that would be great. We'd be happy to review whatever you come up with. 😄

[github-actions]

Do you have any feedback for the maintainers? Please tell us by taking a one-minute survey. Your responses will help us understand Apollo iOS usage and allow us to serve you better.