CodeIgniter 2.0 Released, User-Contributed Notes Coming

In my initial post after joining the CodeIgniter Reactor team (over Thanksgiving weekend ’10), I went as far as to saying that you could hold me responsible for the quality of the CodeIgniter documentation. Here’s a universal truth: Documentation > magic.

CodeIgniter 2.0 was released last week, with an announcement on the EllisLab news feed. The “Reactor” project is now considered to be “CodeIgniter”. All official forum references, downloads, and docs referring to CodeIgniter are referring to the project sitting here at BitBucket.

You can check out the lengthy change-log here: http://codeigniter.com/user_guide/changelog.html

Version 2.0 was released while some big features were still in development (but not 100% ready for the limelight). My favorite upcoming feature (by no coincidence) is something I’m currently putting together: A user-contributed note system for the user guide.

Everyone who keeps a place in their heart for PHP (as hard as it may be at times) knows how helpful php.net is. It’s a single place for clear PHP documentation, code examples, and user-contributed notes.

Some would argue that the most helpful parts of the PHP docs are the notes that PHP developers contributed themselves. A long-time request for CodeIgniter has been to add something similar the user guide.

Since late December, I’ve worked been working on (and have pretty much completed) a full-featured versioned user-contributed notes system for the docs. You can the see the progress in the BitBucket ‘user-notes’ branch:  https://bitbucket.org/ellislab/codeigniter-reactor/src/a6f52cbc8229

The actual application used to host the notes is being developed at: https://bitbucket.org/katzgrau/ci-userguide-notes

And of course, some screenshots of notes in action:

Adding a note looks like a clone of the contribution page at PHP.net:

You can check out a live instance of a user guide with the new system here (link not guaranteed to work into the future!): http://ci-notes-exp.katzgrau.com/user_guide/libraries/benchmark.html

Like I mentioned, the notes are versioned. That means notes can be promoted from older versions to newer versions, and they can be pruned from newer versions as they become obsolete, without affecting the old. Best of all, the user_guide will still come distributed in HTML format with the framework. The notes are pulled in and loaded via some simple Javascript.

I’ve always thought the CodeIgniter docs were the best among any framework that I’ve come across. I think this’ll take them even further.

Look for them at the end of Q1 2011.

This entry was posted in CodeIgniter, PHP Development. Bookmark the permalink. Post a comment or leave a trackback: Trackback URL.
  • http://blog.streambur.se/ Erik Brännström

    Great Scott, this is awesome! It is very much in line with the “new” community-based CodeIgniter development and I am looking forward to see this go live. Well done!

  • Kenny Katzgrau

    Thanks Erik! There are some new features planned that I’ll be talking about in the coming months that really build on the community aspect too.

    More on that a bit farther into development :)

  • http://www.dennisrasmussen.com Dennis Rasmussen

    Don’t forget the “Report” link :-)
    Optionally with a dropdown of possible reasons why it’s reported and a note.