salvo icon indicating copy to clipboard operation
salvo copied to clipboard

Improve documentation and official website

Open chrislearn opened this issue 10 months ago • 5 comments

  • [x] 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 avatar Apr 04 '24 12:04 chrislearn

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

josejachuf avatar Apr 09 '24 17:04 josejachuf

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

CharlieBytesX avatar Sep 04 '24 02:09 CharlieBytesX

@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.

chrislearn avatar Sep 04 '24 02:09 chrislearn

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?

CharlieBytesX avatar Sep 05 '24 13:09 CharlieBytesX

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

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

chrislearn avatar Sep 05 '24 13:09 chrislearn