• 1 Vote(s) - 5 Average
  • 1
  • 2
  • 3
  • 4
  • 5
CI3 User Guide Style

#11
Here's an idea - are there any Sphinx documentation gurus in the crowd? Is it possible to have the "CI2" style dropdown menu for navigation? Can you make one for us? Inquiring minds want to know.

Unless someone can come up with that, it is pointless to keep repeating that we should have the old style documentation.
Reply

#12
(12-16-2014, 05:33 AM)FaraonX Wrote: ...

And I have one question. Do you plan in future multilingual documentation or there will be documentation only in the english language and other languages leave for fans sites?

The User Guide is a living document, updated as part of the codebase. It will be English only.

We have no plans to provide multilingual documentation as part of that - can you imagine providing a code update, and having to also provide updated user guide material in all of X languages? Translations of the User Guide are best left to "fan sites" at the moment.

We are undertaking to provide an official home for translations of the system messages, and that is shaping up nicely.
Reply

#13
(12-15-2014, 02:58 PM)jlp Wrote: We have a new style for the CodeIgniter 3 User Guide, and would love your comments on it!

The user guide can be read online or you can download it and read it offline.

Now it looks waaaay better. Thank you.
Reply

#14
Good job! I like simple styles like this one. Just a little suggestion: I think that navigation buttons prev and next would be useful if shown below/above the h1 tag too.
Reply

#15
It seems that an intermediate step is missing here http://www.codeigniter.com/userguide3/in...ading.html
Where is the one from 2.2.0 to 3.0.0? Big Grin
Reply

#16
Just had to create an account to comment..

It looks nice, thanks for the effort.

1. agree with @peterdenk about color of menu, esp the grey on grey is hard to read.

2. agree with @ivantcholakov about font size for code snippet. would be nice to have it one size larger. Just think about all the time we have to stare at it.

3. It would be nice to have the left menu pre-loaded and don't open new page when clicking main menu. makes a easy navigate menu.

4. Please see the image.. the color of the text, font style just make them hard to read. Can we change that?

[Image: wu2us0.jpg]

All in all, as long as the docs is clear and easy to read for the eye, it's all good. please keep that in mind.
Reply

#17
Its not better then old, I don't like.
Reply

#18
Really ice job!!!
I got to admit that even though I' m new in codeigniter society I' m already used to the oldstyle guide. But I like this one as well. The most important thing is to really help someone get started and later to be able to find in there a good example/solution for most advanced usage. E.g for me the well documented codeigniter 2.0 was the motive to take the decision and move my old functions/classes inside a good, mature php framework. If the fisrt time someone "crashes" on a poorly documented guide difficult to read, that's it.It all ends there..

Above all I m really so satisfied that Codeigniter is still alive and keeps on. Because it's really good and deserves it...
Reply

#19
This is the best CI docs by far, easy reading, IMHO well done!
Reply

#20
Lightbulb 
(12-16-2014, 01:09 PM)ciadmin Wrote: Here's an idea - are there any Sphinx documentation gurus in the crowd? Is it possible to have the "CI2" style dropdown menu for navigation? Can you make one for us? Inquiring minds want to know.

Unless someone can come up with that, it is pointless to keep repeating that we should have the old style documentation.

There must be someone among the members of this forum who knows the ins and outs of Sphinx and can answer that question. Probably this post went past them. Happens easily. Here's a suggestion. Add a new, hrrmm, group under Development called "Call for help" or what ever you find appropriate where the council can ask for assistance. Would make it a lot easier to check if one can help out in any way. Keep it updated so that when help is found [SOLVED] is added to the topic.
Reply


Digg   Delicious   Reddit   Facebook   Twitter   StumbleUpon  


  Theme © 2014 iAndrew  
Powered By MyBB, © 2002-2019 MyBB Group.