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

Improve documentation and official website #746

Open
1 of 3 tasks
Tracked by #745
chrislearn opened this issue Apr 4, 2024 · 5 comments
Open
1 of 3 tasks
Tracked by #745

Improve documentation and official website #746

chrislearn opened this issue Apr 4, 2024 · 5 comments

Comments

@chrislearn
Copy link
Member

chrislearn commented Apr 4, 2024

  • Add more example code to the source code。
  • Newbies to the cors function are prone to encounter problems when using it, and the documentation especially needs to be improved.
  • The documentation of openapi is still very incomplete and needs to be improved.
@chrislearn chrislearn mentioned this issue Apr 4, 2024
7 tasks
@josejachuf
Copy link
Contributor

Add more about handler error, please. Use the thiserror and others

@CharlieBytesX
Copy link

Hello! In which topics of the documentation you need contributions?

@chrislearn
Copy link
Member Author

@CharlieBytesX
There are many areas for improvement

  • The current documentation of many middlewares simply gives example codes, but does not explain in depth how to use them.
  • The OpenAPI documentation is not perfect

In short, I hope that the documentation can be more friendly to novices and make it easier for everyone to learn and use. Any optimization and improvement of the documentation is welcome.

@CharlieBytesX
Copy link

Thanks, do you have a standard for pull requests? Would like to help next week, where is the docs web page repo? Are you talking of internal code documentation or the web page documentation?

@chrislearn
Copy link
Member Author

https://github.com/salvo-rs/website

This is the website repo, you can give PR to this repo.

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

3 participants