Skip to content
Closed
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
3 changes: 3 additions & 0 deletions .github/scripts/deploy-appstarter
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ done
# Copy repo-specific files
cp -Rf ${SOURCE}/admin/starter/. ./

# Reuse the framework AGENTS.md at the project root
cp -Rf ${SOURCE}/admin/framework/AGENTS.md ./AGENTS.md

# Commit the changes
git add .
git commit -m "Release ${RELEASE}"
Expand Down
24 changes: 24 additions & 0 deletions .github/workflows/deploy-distributables.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,30 @@ jobs:
- name: Chmod
run: chmod +x ./source/.github/scripts/deploy-framework

- name: Setup Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3861523e4b97 # v7.0.0
with:
python-version: '3.12'

- name: Install Sphinx
run: |
python -m pip install --upgrade pip
pip install -r ./source/user_guide_src/requirements.txt

# Convert the User Guide to Markdown so coding agents get
# version-matched docs embedded in system/Docs
- name: Build Markdown Docs for agents
run: sphinx-build -b markdown -D exclude_patterns=_static/*,changelogs/*,images/* source build/markdown
working-directory: ./source/user_guide_src

- name: Embed Markdown Docs into system/Docs
run: |
mkdir -p ./source/system/Docs
cp -Rf ./source/user_guide_src/build/markdown/. ./source/system/Docs/

- name: Verify embedded docs
run: test -f ./source/system/Docs/index.md

- name: Deploy
env:
PUSH_TOKEN: ${{ secrets.ACCESS_TOKEN }}
Expand Down
7 changes: 7 additions & 0 deletions admin/framework/AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<!-- BEGIN:codeigniter-agent-rules -->

## This is NOT the CodeIgniter you know

This version has breaking changes — APIs, conventions, and file structure may all differ from your training data. Read the relevant guide in `system/Docs/` (framework distribution) or `vendor/codeigniter4/framework/system/Docs/` (app starter installed via Composer) before writing any code. Heed deprecation notices.

<!-- END:codeigniter-agent-rules -->
1 change: 1 addition & 0 deletions user_guide_src/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
sphinx>=8.0.0,<9.0.0
sphinx-markdown-builder>=0.6.0
sphinxcontrib-phpdomain>=0.11.0
docutils>=0.19
sphinx-rtd-theme>=3.0.0
Expand Down