Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Add documentation #55

Closed
m-o-e opened this Issue May 2, 2013 · 3 comments

Comments

Projects
None yet
3 participants

m-o-e commented May 2, 2013

Please

  • Explain how each protection works and the corner cases
  • Explain how to correctly implement each protection in a Rack/Sinatra app
  • Explain how to test each protection in a live app (to ensure they are properly enabled)

@m-o-e m-o-e closed this May 2, 2013

@rkh rkh reopened this May 2, 2013

m-o-e commented May 2, 2013

Ha! ;)

To clarify what was going on: I closed my request after realizing that the code is actually quite well-documented and easy to follow. Thus personally I don't need the docs anymore, but I still think new users would benefit from some guidance. Especially with regard to the critical protections that are disabled by default (CSRF!), which is imho not obvious from the current README.

Owner

rkh commented May 2, 2013

There are CSRF protections that are not disabled by default. We need to make docs more accessible and actually give more examples.

@zzak zzak referenced this issue in sinatra/sinatra.github.com Mar 29, 2015

Closed

Add protection docs to the site #161

Owner

zzak commented Jul 28, 2016

I would agree there is serious lack of examples, but the docs should be accessible now as of closing #161.

I'll close this now and open up a new ticket upstream to explain the situation -- which hopefully will gain more traction than this repo.

@zzak zzak closed this Jul 28, 2016

@zzak zzak referenced this issue in sinatra/sinatra Jul 28, 2016

Open

Rack::Protection more examples in docs #1154

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