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

[FEAT]: Improved Project Documentation #60

Open
nehaljadav opened this issue Nov 12, 2023 · 3 comments
Open

[FEAT]: Improved Project Documentation #60

nehaljadav opened this issue Nov 12, 2023 · 3 comments
Labels
Feature good first issue Good for newcomers

Comments

@nehaljadav
Copy link

nehaljadav commented Nov 12, 2023

Improved Project Documentation

Description:

I am requesting more detailed documentation for the deno_rest project. The current documentation seems [brief], and I believe that providing more detailed information on

  • how to create new module
  • how to create new api
  • common api response structure for frontend
  • all api through postman,
  • more detailed code explanation
  • one click module creation, for example it will ask some information related to new module in form submit in vscode and all files related to that module will be created.
  • deeper WebSocket best practice example
  • api for multipart-form data (file upload)
  • pagination best practice example

would greatly benefit the community.

Thank you for your attention to this matter.

@vicky-gonsalves vicky-gonsalves added the good first issue Good for newcomers label Nov 23, 2023
@vicky-gonsalves
Copy link
Collaborator

@nehaljadav would you like to assign this issue to yourself?

@nehaljadav
Copy link
Author

Sure, with your guidance I will try my best.

@vicky-gonsalves
Copy link
Collaborator

Sure, with your guidance I will try my best.

Moving this conversation under Discussions
#61

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants