OpenCog REST API Documentation

[ceefour]

@cosmoharrigan In addition to merging this, you need to rename rest-api-documentation GitHub project to opencog.github.io, then you can visit:

http://opencog.github.io/

Refs opencog/opencog#928 (comment)

[2bigO]

I have no idea what this is gonna be, but just noticed that you have
library js files in this PR. A good practice is to use CDN instead of
uploading the js lib files, this reduces both the commit history size and
the page's load time.

A good place to find CDNs:
www.cdnjs.com

[ceefour]

@keyvan-m-sadeghi It's true, but I'm simply copying the code from swagger-ui as-is.

I can replace the references with CDN ones, but that means it's going to be more work to update later when there is a new version of swagger-ui, since you have to reapply the changes.

That said, it's up to you guys to decide CDN benefits is worth the effort.

[2bigO]

I defer to others, though note that it's possible to link a certain version
of a lib in cdnjs. Nice work, thanks!

[2bigO]

Ah I see what you mean now, that'd be just the modification of js version
numbers vs overwriting the whole lib files.

[cosmoharrigan]

Thanks, @ceefour. I am thinking of making it a project site inside the organization, rather than an organization site.

[ceefour]

@cosmoharrigan In that case, please create an orphan gh-pages branch on
opencog project instead.
On Jul 17, 2014 9:32 AM, "Cosmo Harrigan" notifications@github.com wrote:

Merged #1 #1.

—
Reply to this email directly or view it on GitHub
#1 (comment)
.

[cosmoharrigan]

@ceefour the site is now active at the following URL:
http://opencog.github.io/rest-api-documentation/
Thanks for taking this initiative.

[cosmoharrigan]

@ceefour if you like, it could be a good idea to post on the mailing list informing others about this browsable API documentation.

[ceefour]

@cosmoharrigan Done :) You're welcome, my pleasure