Skip to content
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.

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

Documentation about client generation some improvements that should be added #2047

Open
Grummfy opened this issue Oct 24, 2024 · 1 comment

Comments

@Grummfy
Copy link

Grummfy commented Oct 24, 2024

Hello,
I think some improvement is required on the documentation about client-generation (so /create-client)

  1. All page in this section should have a link to the troubleshooting page (/create-client/troubleshooting/)
  2. The troubleshooting page should have some extra elements
  • # Authenticated API forget to tell that that the generator now include --bearer or --username & --password options. And perhaps being more explicit about which endpoint should be accessible or not (and link to the doc the page of configuration if required)
  • A general advice on using --help could also ease some solution
  1. Add example of generated files (if it exist, I miss them)
  2. Add example of custom template for existing generator (it's possible but except if we read the code, I don't think it's really usable)

Should I create separated issue for that? I will try to find some times to add some of theses elements in the doc

@vinceAmstoutz
Copy link
Contributor

vinceAmstoutz commented Oct 25, 2024

@Grummfy You're welcome to contribute, check our CONTRIBUTING.md and submit your suggestions. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants