CodeIgniter Documentation Project

The aim of this project is to convert the CodeIgniter User Guide from the existing reStructuredText format to Markdown format, making it easier to maintain and contribute to, as well as allowing all of our projects to share a common documentation format.

Configuration

The converter can work with two different source types:

1. Local docs-rst folder (default) - Uses the docs-rst folder in this project
2. CodeIgniter4 project - Points to a CodeIgniter4 project's user_guide_src/source folder for latest docs

To configure, copy .env.dist to .env and modify as needed:

cp .env.dist .env

Example configurations:

For local docs-rst (default):

DOCS_SOURCE_TYPE=local
DOCS_PROJECT_PATH=

For CodeIgniter4 project:

DOCS_SOURCE_TYPE=project
DOCS_PROJECT_PATH=/path/to/CodeIgniter4/user_guide_src/source/

The Conversion Process

The conversion process is being done using pandoc to do the initial conversion. From there, each section and file will be manually reviewed and cleaned up as needed.

Once the conversion is complete, we will start taking a look at the overall structure of the documentation and see what changes need to be made for consistency, clarity, and ease of understanding.

Requirements

To convert, pandoc is required. To install it, see https://pandoc.org/installing.html.

Generation of the final documentation uses MkDocs with the Material for MkDocs theme. See How to Build Docs for more details.

Next Steps:

• Build converter script to convert all files from rst to md
• Modify converter to insert code samples and remove unnecessary files.
• Review and clean up converted files
• Review and clean up overall structure of documentation
• Standardize how pages are written to include cohesive structure and examples

Commands:

Converting all files

To convert all files from rst to md:

php ./admin/convert.php

Note

This will first delete all files and directories in the ./docs directory, except for the assets directory, which contains images and other assets used by the documentation.

You can also convert individual files:

php ./admin/convert.php filename

See how to use filters for more details about the conversion process.

Previewing the converted files

See the How to Build Docs document for instructions on building and previewing the converted files.