search

trigger-corp / browser-extensions

Build and run cross-platform browser extensions from one codebase.
Other
312 stars 52 forks source link

Any plans to add docs to the repo? #12

Closed jtremback closed 10 years ago

jtremback commented 10 years ago

I do feel a little sketched out using docs that have a big red warning at the top. Also, I get a bit confused when I click on something for the browser extension docs and the sidebar is showing that method name for the mobile API. Would you guys accept a pull request for a nice markdown file with all the docs? If not, why not?

antoinevg commented 10 years ago

I'd be delighted to review a pull request for a nice markdown file with all the docs!

jtremback commented 10 years ago

Choosing between this and a couple of other options right now. If I use the project, I'll make that file.

patcon commented 10 years ago

@jtremback can I ask what project you ended up using? Or which you were considering, for that matter :)

patcon commented 10 years ago

Brought convo over from https://github.com/trigger-corp/browser-extensions/pull/20#issuecomment-42682414.

Hm. Looking at RTD makes me really miss jekyll, which github pages is base off of. fwiw jekyll-rack can be used to host a static jekyll site on heroku, which we can easily deploy on each commit using travis: http://blog.crowdint.com/2010/08/02/instant-blog-using-jekyll-and-heroku.html

It would also seem to circumvent my prior concern with jekyll in that it used to require being in the root repo, and so required a separate branch if it were part of a code repo.

cc: @makern

makern commented 10 years ago

We mainly need something that can be easily edited and versioned in the repository. Since github will render both markdown and restructuredtext automatically, either of them will work and we can worry about where to host it as separate website later?

jtremback commented 10 years ago

@patcon I ended up using gulp.js to concatenate all of my templates and css into one js file that gets launched by a very minimal browser extension (all it needs to do is run one script). This removed the burden of having to load static assets in different ways for different browsers. This wouldn't work for a more complicated extension of course.

patcon commented 10 years ago

@makern :+1: in general and +1 for markdown :)

@jtremback thanks man!