CodeIgniter Forums
Generating on online Users Guide like CI's - Printable Version

+- CodeIgniter Forums (https://forum.codeigniter.com)
+-- Forum: General (https://forum.codeigniter.com/forum-1.html)
+--- Forum: Lounge (https://forum.codeigniter.com/forum-3.html)
+--- Thread: Generating on online Users Guide like CI's (/thread-70635.html)

Pages: 1 2


Generating on online Users Guide like CI's - richb201 - 05-06-2018

I need to offer my users a guide to using my CI based system. I kind of like the online documentation for CI. What was it built with? Are there any available "templates" that were used? How about screenshots? How do I annotate screenshots with text and arrows?


RE: Generating on online Users Guide like CI's - jreklund - 05-06-2018

It's in the footer.

Built with Sphinx using a theme provided by Read the Docs.

https://alternativeto.net/software/read-the-docs/


RE: Generating on online Users Guide like CI's - richb201 - 05-06-2018

Thanks Jre. I did take a look at Sphinx but I thought it was way too complicated.


RE: Generating on online Users Guide like CI's - skunkbad - 05-06-2018

For my Community Auth website, I just used WordPress and created a custom WordPress theme.


RE: Generating on online Users Guide like CI's - richb201 - 05-06-2018

Thanks skunk. I also have wordpress installed and planned to do the site with it. If you had to do it again would you do it that way? I had planned to use Helpinator, but I am not sure it totally works. I have taken screenshots of all the significant parts but I can't figure out how to annotate them, even though that is covered in their help system. If I can't find it, how would I annotate screen shots?


RE: Generating on online Users Guide like CI's - ritz.stine - 05-06-2018

(05-06-2018, 08:22 AM)skunkbad Wrote: For my Community Auth website, I just used WordPress and created a custom WordPress theme.

I also do the same, as I find it easy to use the same platform which is WordPress.


RE: Generating on online Users Guide like CI's - InsiteFX - 05-07-2018

You could also download CodeIgniter version 2.2.6 and use it's User Guide which was made for making User Guides etc;


RE: Generating on online Users Guide like CI's - richb201 - 05-07-2018

Insite, I am confused. How can I tell what version of CI I am running? I am pretty sure that I am in the 3.18 range (maybe a little back). Wouldn't I break lots of things if I step back to 2.2.6?


RE: Generating on online Users Guide like CI's - skunkbad - 05-07-2018

(05-06-2018, 12:06 PM)richb201 Wrote: Thanks skunk. I also have wordpress installed and planned to do the site with it. If you had to do it again would you do it that way? I had planned to use Helpinator, but I am not sure it totally works. I have taken screenshots of all the significant parts but I can't figure out how to annotate them, even though that is covered in their help system. If I can't find it, how would I annotate screen shots?

In general I really hate WordPress, but for something like this it actually works perfectly. Plus, out of the box it includes search. It's a fairly painless theme to create for a website like this.


RE: Generating on online Users Guide like CI's - InsiteFX - 05-07-2018

PHP Code:
<?php echo CI_VERSION?>

That's how you can always get the CodeIgniter Version.

Version 2.2.6 was the last version that had the old User's Guide that you could make your own.