openapi-codegen chore: documentation

related #105

Oct 04 '22 20:10 needim

table of contents
~~fetcher and context only generated once for userland.~~
~~you should modify your fetcher and context for your own needs~~.
on init if you choose Typescript Types it only generates Types
on init if you choose Generic Fetchers it generates Types and Fetchers
on init if you choose React Query Components it generates Types and Fetchers and React Query Components
~~whatever you choose on init, you can always edit openapi-codegen.config.ts later and add additional generators if you want.~~
~~adding terminal init gif to readme can help users to understand what the init function actually does~~
better collapsable readme for sections "What do you want to generate?" (for example)
- Types
- Fetchers
- React Query
FAQ
Error Handling in fetcher

Oct 04 '22 20:10 needim

@needim Would table of contents fit into this PR?

Oct 05 '22 00:10 ANDREYDEN

Of course!

Oct 05 '22 04:10 needim

example gif demo.

openapi-codegen-init

Oct 05 '22 07:10 needim

@needim, I added some suggestions to your branch.

Oct 12 '22 10:10 ANDREYDEN

proposal: more declarative wordings in the init function:

Types
Types & Fetchers
Types & Fetchers & React Query hooks

Oct 15 '22 19:10 needim

proposal: more declarative wordings in the init function:

Types

Types & Fetchers

Types & Fetchers & React Query hooks

@needim I would suggest having 3 options (Types, Fetchers, React Query hooks) and have a multiselect functionality (spacebar to add an option, enter to submit). You can refer to the Firebase CLI for an example.

Oct 15 '22 21:10 ANDREYDEN

This looks good enough to be merge, let’s merge and iterate on further PRs :)

Mar 14 '23 14:03 fabien0102