Document what to do next

[damienmckenna]

It's not clear from the project's description if code is automatically generated for the new APIs, or if it just provides a compatibility layer that people can then manually rewrite one by one after the fact. #53 might help with this if it were possible to list the specific hooks that were being provided.

[mglaman]

Should https://github.com/retrofit-drupal/retrofit?tab=readme-ov-file#how-it-works be expanded to explicit say it doesn't generate code?

Documentation is definitely lacking. I got struck by build functionality and decision paralysis on how to handle docs – markdown in the repo and/or how to integrate with a proper site https://retrofit-drupal.com/

Documentation is one of the next things I want to do to ease adoption/trying out

[mglaman]

@damienmckenna I opened #62 – what is better to do? Document as "Supported APIs" or "Backward compatible layers" and focus more granularly on each hook or feature?

The latter may make it easier to document how global $user is supported.

[darrenoh]

We could add deprecation notices to help people identify code that is relying on Retrofit.