codeigniter-starting-point icon indicating copy to clipboard operation
codeigniter-starting-point copied to clipboard

Documentation

Open janosrusiczki opened this issue 15 years ago • 8 comments

It would be great if you'd extend the readme to a sort of a documentation of what's included and how to use everything. This way you'd make it useful for other people too. Hint hint.

janosrusiczki avatar Feb 14 '11 16:02 janosrusiczki

Hey,

Yeah a list of additions, and structure in the README is a good idea. Open source is never as easy as just opening up the source code :)

I am going to create a 2.0 version as well. I was thinking of keeping two directories for 1.7.3 and 2.0 but perhaps it makes sense to just have the latest version. Going through the process of upgrading apps and libraries to 2.0 at the moment. Seems to created quite a backlog.

ollieza avatar Feb 14 '11 17:02 ollieza

Hey,

Added a list of the changes with some explanation to the README which is shown at https://github.com/ollierattue/codeigniter-starting-point

What do you reckon Janos (kitsched)? Do you reckon the average user of this code (i.e. someone familiar with CI) would be able to work their way around?

Would take me a large chunk of time to document completely...

ollieza avatar Feb 15 '11 13:02 ollieza

It's certainly starting to look better. :)

The next step would be to provide documentation URLs for the used libraries / helpers.

I don't want to be misunderstood: I really appreciate the work you've done here and I'm just trying to help with things I, as a fellow developer, would need to start working with your fork.

Although that's sort of unlikely since I recently transitioned to CI 2.0...

janosrusiczki avatar Feb 15 '11 13:02 janosrusiczki

Hey,

I always appreciate feedback. Added some URLS for helpers/libraries where applicable.

My next todo is to convert to CI 2.0. I use this code and need to host the source, so it makes sense for me to do it publicly. However to document everything would take a good chunk of time. If interest arrises I will. At the moment it's just about code out there.

Thanks,

ollieza avatar Feb 16 '11 17:02 ollieza

Even if you do not convert to CI 2.0, I found some very useful stuff around here which I'll be integrating in my future / current projects.

janosrusiczki avatar Feb 17 '11 06:02 janosrusiczki

Ollie, this is simply great. Can't wait for 2.0 release

dedurus avatar Apr 09 '11 17:04 dedurus

Hey dedurus,

Thanks for your kind words. CI Starting Point is quite a big release for me, representing some of the best CI code and methods I have used or developed over the last 3 years. I will be working towards a 2.0 release but am currently snowed with client work. Feel free to make a fork if you want to get a head start.

Thanks,

ollieza avatar Apr 09 '11 18:04 ollieza

I would really like to get some more exposure to Starting Point after the 2.0 upgrade. As highly opinionated code others might not agree 100% with the way I do things but I think a lot of people would find a lot of the code useful. I guess a micro-site and more in depth documentation is the next step. Just feels like quite a big project with a lot of ongoing maintenance, and time commitment...

ollieza avatar Apr 09 '11 18:04 ollieza