try to make SPEC more accessible

mjackson / strata

A modular, streaming HTTP server for node.js

http://stratajs.org

365 stars 35 forks source link

try to make SPEC more accessible #6

Closed bronson closed 13 years ago

bronson commented 13 years ago

Embraced MarkDown, tried to improve readability
Organized properties into sections
Added optional properties since they were mentioned in the document anyway.
Removed some of the Rackisms inherited from Rack's SPEC.

Also, I feel like X-Cascade still needs to be documented, and probably also Content-Length in relation to chunked responses...?

Feel free to reject some or all of this, it's just an experiment.

mjackson commented 13 years ago

Good points about X-Cascade and Content-Length in relation to chunked responses. I will definitely put those on my todo list!

As far as these commits go, I think I'd rather leave SPEC a plain text file for now. There are a few formatting issues that Markdown doesn't entirely support, like the property lists, and plain text suits them very well. This may at some point be changed, so thank you for your experiment. :)