Documentation

[jasonbahl]

What problem does this address?

WPGraphQL for ACF needs documentation for both new users and users looking to upgrade from WPGraphQL for ACF v0.6.1 or older.

What is your proposed solution?

I would like to see documentation for the following:

• Upgrade Guide
  • Breaking Changes
    • Schema Diffs (show the diffs of the Schema between WPGraphQL for ACF v0.6.3 and WPGraphQL for ACF 2.0. . .maybe automate this? 🤔)
    • Field and Type name changes
      • Some fields and Types might be slightly different as we've tried to make things a bit more consistent with the core WPGraphQL naming conventions.
    • GraphQL Types and Fragments (no more Page_, Post_, etc prefixes)
    • Relationship Field Changes
      • Checkbox
      • Image Field
      • File Field
      • Page Link Field
      • Relationship Field
    • Multiple Select Field Changes (always listOf now)
• Quick Start
  • Installation and Activation
  • Adding ACF Field Groups and Fields to the GraphQL Schema
  • Adding ACF Post Types and Taxonomies to the GraphQL Schema
  • Adding ACF Options Pages to the GraphQL Schema
  • Using GraphQL Interfaces to Query for Field Groups
  • Adding support for 3rd Party ACF Field Types
  • Debugging
• Field Types (documentation for each field type)
  • Advanced Link
  • Button
  • Button Group
  • Checkbox
  • Clone Field
  • Code Editor
  • Color Picker
  • Countries
  • Currencies
  • Date Picker
  • Date Range Picker
  • Date Time Picker
  • Email
  • File
  • Flexible Content
  • Gallery
  • Google Map
  • Group
  • Image
  • Image Selector
  • Image Sizes
  • Languages
  • Link
  • Menu Locations
  • Menus
  • Number
  • Oembed
  • Page Link
  • Password
  • Phone Number
  • Post Object
  • Radio
  • Range
  • Relationship
  • Repeater
  • Select
  • Taxonomies
  • Taxonomy
  • Taxonomy Terms
  • Text
  • Text Area
  • Time Picker
  • True / False
  • Url
  • User
  • User Roles
  • WYSIWYG
• Hooks and Filters

What alternatives have you considered?

n/a

Additional Context

While one might argue that documentation could/should live in the repo as .md / .mdx files, I am building the documentation in WordPress using WPGraphQL and WPGraphQL for ACF 2.0. . .drinking our own champagne 🥂!

This may or may not change in the future, but I think it will be a great artifact for folks to learn from, and it's already been good at helping me expose bugs, by using the product myself