i don't think it makes much sense to include the README file, since that is required to get the server started. which makes it a bit of a chicken-and-egg problem ;) i also don't see much value in having the README available there. what might be more interesting is a license file in the docs.

also, this needs a test before it can go in. test should ensure that /api/ works, that requesting a non-existent file fails and requesting and existing file returns the actual file contents (the test can load it from disk to compare)

function serverPath(path)

    var filename = path.basename(req.url);

this means we can't have subdirs in the doc/ directory. perhaps better would be to call path.normalize .. sth like:

app.get('/api/(.*)', function(req, res) {
    var filename = path.normalize(req.params[0]);

this allows subdirs, and protects against things like '..' causing problems.

function serverPath(path)

    var filenameData = fs.readFileSync(filePath, 'utf8');

this should be an async read with the callback sending the file contents.

also, if the file does not exist the 404 page should be sent.

- Aaron J.

On May 31st, 2013, 5:59 p.m. UTC, Antonis Tsiapaliokas wrote:

Hello

with that patch i am adding the following support to the bodega-server:

1) server/doc is the place which all of our documentaion lives.
2) The docs are accessible from /api/filename.E.x. for docs/README.markdown => api/README

If you all agree with that patch, i will push it to the branch which i am referring above(kokeroulis/markdown/documentation)

P.S. the two files are from bodega-server and bodega-client