Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/carson.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ settings:
files: ['.github/workflows/*']
- label: documentation
files:
all: ['user_guide_src/source/**']
all: ['docs/**']
- label: testing
files:
all: ['tests/**']
Expand Down
9 changes: 9 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,12 @@ updates:
patterns:
- '*'
group-by: dependency-name

- package-ecosystem: 'pip'
directory: '/docs'
schedule:
interval: 'weekly'
groups:
user-guide-dependencies:
patterns:
- '*'
10 changes: 7 additions & 3 deletions .github/instructions/user-guide.instructions.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
---
applyTo: "user_guide_src/**/*.rst"
applyTo: "docs/**/*.md"
---

# User guide

- Preserve the existing reStructuredText structure, terminology, directives,
- Preserve the existing Markdown structure, terminology, admonitions,
anchors, and surrounding writing style.
- Indent nested lists and admonition bodies by four spaces, and keep the two
trailing spaces that end a line as a hard line break.
- Add a new page to the page's folder `index.md` and run
`php admin/update-docs-nav.php` to add it to `docs/.nav.yml`.
- Keep PHP examples compatible with PHP 8.2 and verify signatures and behavior
against the current framework code.
- Distinguish new behavior from existing behavior and document defaults
Expand All @@ -22,6 +26,6 @@ applyTo: "user_guide_src/**/*.rst"
smallest migration in both the minor changelog and upgrading guide.
- Keep code examples minimal but complete enough to run in a normal
CodeIgniter application.
- Leave the complete Sphinx build and documentation validation to GitHub
- Leave the complete MkDocs build and documentation validation to GitHub
Actions unless the task specifically requires local documentation
validation.
2 changes: 1 addition & 1 deletion .github/instructions/worker-mode.instructions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
applyTo: "system/Boot.php,system/CodeIgniter.php,system/Commands/Worker/**,system/Config/BaseService.php,system/Config/Factories.php,system/Config/Factory.php,system/Config/Services.php,system/Database/Config.php,system/Database/BaseConnection.php,system/Database/ConnectionInterface.php,system/Database/*/Connection.php,system/Events/Events.php,system/Session/**,system/Cache/**,system/HTTP/**,system/Filters/**,system/Router/**,system/Security/**,system/Debug/Toolbar.php,system/Debug/Toolbar/**,app/Config/WorkerMode.php,tests/system/Commands/Worker/**,user_guide_src/source/installation/worker_mode.rst"
applyTo: "system/Boot.php,system/CodeIgniter.php,system/Commands/Worker/**,system/Config/BaseService.php,system/Config/Factories.php,system/Config/Factory.php,system/Config/Services.php,system/Database/Config.php,system/Database/BaseConnection.php,system/Database/ConnectionInterface.php,system/Database/*/Connection.php,system/Events/Events.php,system/Session/**,system/Cache/**,system/HTTP/**,system/Filters/**,system/Router/**,system/Security/**,system/Debug/Toolbar.php,system/Debug/Toolbar/**,app/Config/WorkerMode.php,tests/system/Commands/Worker/**,docs/installation/worker_mode.md"
---

# FrankenPHP Worker Mode
Expand Down
2 changes: 1 addition & 1 deletion .github/skills/forum-announcement/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Create a forum-ready CodeIgniter4 release announcement using myBB markup.

## Procedure
1. Read `CHANGELOG.md` for release summary and PR references.
2. Read `user_guide_src/source/changelogs/v{VERSION}.rst` for each target version.
2. Read `docs/changelogs/v{VERSION}.md` for each target version.
3. Determine release mode:
- Single release: one `4.x.y` version.
- Dual release: maintenance + major; maintenance is presented first in the post.
Expand Down
47 changes: 19 additions & 28 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,18 @@ $RECYCLE.BIN/
# These should never be under version control,
# as it poses a security risk.
.env
.vagrant
Vagrantfile
/user_guide_src/venv/

#-------------------------
# Local Configuration
#-------------------------
# phpenv local config
.php-version

# pyenv local config
.python-version
/user_guide_src/.python-version

/phpunit.xml
/.php-cs-fixer.php

#-------------------------
# Temporary Files
Expand All @@ -72,21 +79,19 @@ Vagrantfile
php_errors.log

#-------------------------
# User Guide Temp Files
# Build Output
#-------------------------
/user_guide_src/build/*
# Test coverage
/build/

# phpDocumentor
/api/

# User guide
/site/
/venv/
__pycache__/

#-------------------------
# Test Files
#-------------------------
/tests/coverage*

# Don't save phpunit under version control.
/phpunit

#-------------------------
# Composer
#-------------------------
Expand All @@ -97,21 +102,13 @@ composer.lock
# IDE / Development Files
#-------------------------

# Modules Testing
_modules/*

# phpenv local config
.php-version

# Jetbrains editors (PHPStorm, etc)
.idea/
*.iml

# Netbeans
/nbproject/
/build/
/nbbuild/
/dist/
/nbdist/
/nbactions.xml
/nb-configuration.xml
Expand All @@ -124,12 +121,6 @@ _modules/*
*.sublime-workspace
*.sublime-project
.phpintel
/api/

# Visual Studio Code
.vscode/

/results/
/phpunit.xml

/.php-cs-fixer.php
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ More information about the plans for version 4 can be found in [CodeIgniter 4](h

The [User Guide](https://codeigniter.com/user_guide/) is the primary documentation for CodeIgniter 4.

You will also find the [current **in-progress** User Guide](https://codeigniter4.github.io/CodeIgniter4/).
You will also find the [current **in-progress** User Guide](https://codeigniter4.github.io/CodeIgniter4/develop/).
As with the rest of the framework, it is a work in progress, and will see changes over time to structure, explanations, etc.

You might also be interested in the [API documentation](https://codeigniter4.github.io/api/) for the framework components.
Expand Down
39 changes: 13 additions & 26 deletions admin/framework/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,14 @@ $RECYCLE.BIN/
# These should never be under version control,
# as it poses a security risk.
.env
.vagrant
Vagrantfile

#-------------------------
# Local Configuration
#-------------------------
# phpenv local config
.php-version

/phpunit.xml

#-------------------------
# Temporary Files
Expand All @@ -66,20 +72,13 @@ Vagrantfile
php_errors.log

#-------------------------
# User Guide Temp Files
#-------------------------
/user_guide_src/build/*
/user_guide_src/cilexer/build/*
/user_guide_src/cilexer/dist/*
/user_guide_src/cilexer/pycilexer.egg-info/*

#-------------------------
# Test Files
# Build Output
#-------------------------
/tests/coverage*
# Test coverage
/build/

# Don't save phpunit under version control.
/phpunit
# phpDocumentor
/api/

#-------------------------
# Composer
Expand All @@ -90,21 +89,13 @@ vendor/
# IDE / Development Files
#-------------------------

# Modules Testing
_modules/*

# phpenv local config
.php-version

# Jetbrains editors (PHPStorm, etc)
.idea/
*.iml

# NetBeans
/nbproject/
/build/
/nbbuild/
/dist/
/nbdist/
/nbactions.xml
/nb-configuration.xml
Expand All @@ -117,10 +108,6 @@ _modules/*
*.sublime-workspace
*.sublime-project
.phpintel
/api/

# Visual Studio Code
.vscode/

/results/
/phpunit.xml
39 changes: 13 additions & 26 deletions admin/starter/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,14 @@ $RECYCLE.BIN/
# These should never be under version control,
# as it poses a security risk.
.env
.vagrant
Vagrantfile

#-------------------------
# Local Configuration
#-------------------------
# phpenv local config
.php-version

/phpunit.xml

#-------------------------
# Temporary Files
Expand All @@ -66,20 +72,13 @@ Vagrantfile
php_errors.log

#-------------------------
# User Guide Temp Files
#-------------------------
/user_guide_src/build/*
/user_guide_src/cilexer/build/*
/user_guide_src/cilexer/dist/*
/user_guide_src/cilexer/pycilexer.egg-info/*

#-------------------------
# Test Files
# Build Output
#-------------------------
/tests/coverage*
# Test coverage
/build/

# Don't save phpunit under version control.
/phpunit
# phpDocumentor
/api/

#-------------------------
# Composer
Expand All @@ -90,21 +89,13 @@ vendor/
# IDE / Development Files
#-------------------------

# Modules Testing
_modules/*

# phpenv local config
.php-version

# Jetbrains editors (PHPStorm, etc)
.idea/
*.iml

# NetBeans
/nbproject/
/build/
/nbbuild/
/dist/
/nbdist/
/nbactions.xml
/nb-configuration.xml
Expand All @@ -117,10 +108,6 @@ _modules/*
*.sublime-workspace
*.sublime-project
.phpintel
/api/

# Visual Studio Code
.vscode/

/results/
/phpunit.xml
5 changes: 0 additions & 5 deletions admin/userguide/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,4 @@
!*/cache/index.html
!*/cache/.htaccess

user_guide_src/build/*
user_guide_src/cilexer/build/*
user_guide_src/cilexer/dist/*
user_guide_src/cilexer/pycilexer.egg-info/*

/vendor/
Binary file removed contributing/ELDocs.tmbundle.zip
Binary file not shown.
Loading
Loading