hyper-reverse-proxy icon indicating copy to clipboard operation
hyper-reverse-proxy copied to clipboard

Update the docs

Open felipenoris opened this issue 2 years ago • 5 comments

  • [ ] rewrite docs main page with new examples
  • [ ] static client
  • [ ] ws support
  • [ ] notes on security
  • [ ] sync README.md with main page docs

felipenoris avatar May 21 '22 17:05 felipenoris

Do yu mean the docs inside lib.rs?

somehowchris avatar Jun 05 '22 12:06 somehowchris

@somehowchris , yes, the doc strings that generate https://docs.rs/hyper-reverse-proxy/latest/hyper_reverse_proxy/ and README.md which is a summary of the docs.

felipenoris avatar Jun 11 '22 18:06 felipenoris

So #45 would include your points 1, 2, 4 & 5 inside the README.md and inside the mod doc, what kind of doc would you suggest for your point ws support. Just mentioning it?

somehowchris avatar Jul 28 '22 16:07 somehowchris

@felipenoris So what's needed for a next release?

somehowchris avatar Jul 29 '22 13:07 somehowchris

Hey @felipenoris,

It just makes me sad seeing such a lovely crate being unmaintained, people are loving it and opening up PRs to suggest awesome things. Do you plan to maintain it? If you need help, would love to chime in

somehowchris avatar Aug 26 '22 22:08 somehowchris