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

Update the docs #36

Open
5 tasks
felipenoris opened this issue May 21, 2022 · 5 comments
Open
5 tasks

Update the docs #36

felipenoris opened this issue May 21, 2022 · 5 comments

Comments

@felipenoris
Copy link
Owner

felipenoris commented May 21, 2022

  • rewrite docs main page with new examples
  • static client
  • ws support
  • notes on security
  • sync README.md with main page docs
@somehowchris
Copy link
Contributor

Do yu mean the docs inside lib.rs?

@felipenoris
Copy link
Owner Author

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

@somehowchris
Copy link
Contributor

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
Copy link
Contributor

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

@somehowchris
Copy link
Contributor

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

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

No branches or pull requests

2 participants