CodeIgniter Forums
Help Needed with Documentation - Printable Version

+- CodeIgniter Forums (https://forum.codeigniter.com)
+-- Forum: General (https://forum.codeigniter.com/forumdisplay.php?fid=1)
+--- Forum: News & Discussion (https://forum.codeigniter.com/forumdisplay.php?fid=2)
+--- Thread: Help Needed with Documentation (/showthread.php?tid=79365)

Pages: 1 2


RE: Help Needed with Documentation - renela - 08-20-2021

Can I help?


RE: Help Needed with Documentation - sudeepjd - 08-20-2021

On the folder stucture, the downloaded installation does not have the tests directory either.

However, on the Extending the Controllers questions, there are 2 ways of doing it. Either extending the CodeIgniter System Controller Directly or more preferably extending the BaseController in you app folder. 

This part is documented in : https://codeigniter.com/user_guide/extending/basecontroller.html?highlight=basecontroller

However, a reference to this section can be added into the First Application for clarity.


RE: Help Needed with Documentation - francis94c - 09-01-2021

[quote pid="387342" dateline="1622815646"]
I'm interested.
[/quote]


RE: Help Needed with Documentation - includebeer - 11-17-2021

(11-17-2021, 10:23 AM)vicky101 Wrote: Interface help comes in two forms: proactive and reactive. Proactive help is intended to get users familiar with an interface while reactive help is meant for troubleshooting and gaining system proficiency.
Why are you spamming this forum? You said you wanted to help with documentation. Then just to it. Don't post your philosophic theories on why documentation is important.


RE: Help Needed with Documentation - kenjis - 11-17-2021

(06-24-2021, 01:50 AM)acutetech Wrote: My question was: is the online documentation up to date, or out of date? As a complete newbie I notice the documentation says "A fresh install has six directories: /app, /system, /public, /writable, /tests and possibly /docs." But my fresh installation (via Scriptaculous) is different. It has these top-level directories: /app, /public, /tests, /vendor, /writable This makes me think the documenation is not up to date, which is of some concern as I will have to rely on docs (and forum).

Thank you!

I sent a PR to fix it.
https://github.com/codeigniter4/CodeIgniter4/pull/5347

(06-24-2021, 01:50 AM)acutetech Wrote: Also, the "First Application" tutorial Pages.php has this:

Code:
namespace App\Controllers;
use CodeIgniter\Controller;
class Pages extends Controller

which differs from the fresh installation Home.php which has this:

Code:
namespace App\Controllers;
class Home extends BaseController

Should I be concerned by these differences? Are they deliberate or do they represent out of date documentation?

I sent a PR to fix it.
https://github.com/codeigniter4/CodeIgniter4/pull/5348

Using BaseController is recommended. Because if you want to add something to all your controller later,
you could do it with BaseController.

But if you don't use BaseController, extend Controller, your controller is completely fine.


RE: Help Needed with Documentation - kenjis - 11-17-2021

(08-20-2021, 08:44 PM)sudeepjd Wrote: On the folder stucture, the downloaded installation does not have the tests directory either.

Thank you. It must be a bug.

I sent a PR to fix it.
https://github.com/codeigniter4/CodeIgniter4/pull/5350

Hi all.

When you send Pull Requests (PRs), you might fix the User Guide very quickly like the following.

The current in-progress User Guide
The fixes will be included the next release.

See https://github.com/codeigniter4/CodeIgniter4/blob/develop/contributing/README.md

I recommend you send a very small PR first, not a very big one.


RE: Help Needed with Documentation - kenjis - 12-01-2021

We need your help.

There are many PRs to improve the documentation.
But it seems there are no reviewers at the moment.
https://github.com/codeigniter4/CodeIgniter4/pulls?q=is%3Apr+is%3Aopen+label%3Adocumentation+sort%3Aupdated-desc

If someone has time, please review and approve the PRs if it is okay!