shawnrice/bundler-docs

Documentation Development for Alfred Bundler

Alfred Bundler Docs

This repo exists just to help develop documentation for the Alfred Bundler. So, this repo can be considered a dev site for the bundler's gh-pages.

Credits

These docs are built on Zurb's Foundation 5 framework.

bundler-docs's Issues

Applescript Quickstart Page

Can you do the Applescript Quickstart page? The HTML is a file called quickstart-applescript.html, and I've already made the stub.

Take a gander at the quickstart-php.html file to see the sort of thing I have in mind.

Implementation

So, I put together an "implementation" page that shows a sort of "best" practices for initializing the Bundler.

I have sample code currently for Ruby and PHP to catch exceptions, and I'll push some shortly for a Bash trap.

@smargh Can you do the code for the AppleScript? And can someone else do the code for the Python?

Python Quickstart

Can you do the Python Quickstart page? The HTML is a file called quickstart-python.html, and I've already made the stub.

Take a gander at the quickstart-php.html file to see the sort of thing I have in mind.

Check Viewports for Mobile

Just need to make sure that all the pages end up looking okay or hiding info when resized to a mobile screen.

Applescript API documentation

@smargh Do you want to write up some API documentation for the AS bundler? Look at the Bash API documentation that I did by hand.

If you don't want to, then don't worry about it and close this issue. If you do, then go for it and close the issue when it is done.

Check Headers and Footers

Just a reminder to check and normalize these before we push the new documentation.

Forum Thread

@deanishe, @Ritashugisha, @smargh: can you weigh in on this:

Right now all the documentation has the footer that points to the original Bundler thread from when I put out the idea and released it. That thread got a bit long when we were doing some dev talk on it. I'm thinking that we just start a new thread that can announce the release of Taurus, but then we can use that for a bit more support. Good idea? Not worth it?

Wrapper Documentation

We need to figure out how to integrate the wrapper documentation into these doc pages.

With the Ruby and the PHP, I included the files in the api-generation, so they're documented that way, but we should push the wrapper-howto into their own pages. I remember that you did a rough draft of the documentation for them. Have you gotten a chance to work on those any more?

Team Page

@deanishe, @Ritashugisha, @smargh: I wrote up a "team" page for us for two reasons, but I want you all to check it out and let me know what you think.

The first reason is to just show us off a bit more. It's nice to have some of the links available, and, really, they can't hurt to have. I used everyone's GH avatar, so if you change those on GH, then they'll change in the docs. For the "Alfred Credits," I selected what seemed like the most popular things we've all done (based on Packal downloads, etc...). But if there is anything in those that you want to add or remove, then feel free to just do so.

The second reason is about "trust." When I talked to Andrew about the Bundler a while ago, he said that he thought it was a clever idea, but he and Vero weren't big fans of it because it seemed to slow things down and make users not so happy that Alfred was apparently installing things on their computers. One result of that conversation was the AppleScript installation messages (although we had started to implement those already), but I quickly wrote up the explanation page so that regular users can understand what's going on (we should change the "more info" button to head to this page rather than the wiki when we push the new documentation — also, I/we need to rewrite that page. I wrote it in ten minutes, and so it's not the best and actually had some grammatical errors, which the makes the college English teacher in me feel disgraced). But, I figure that if we show off a bunch of the stuff that we've done, then it'll make users more likely to trust the Bundler, especially if they've heard of/use some of the stuff that we have.

But... I'm open to changing everything about the page, including its existence if anyone has objects.

I originally included what parts of the bundler we all worked on, but I figured that we'd get rid of that. It seems nicer to make us look like a full team, taking credit together and only together.

Also, for any lists that I've been making (languages, etc...), I've been going lexicographically, but the "team" list has always been in order of start date. I figure that's fair.