Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
414 commits
Select commit Hold shift + click to select a range
09ceb45
Update python package for Node 22 (#329)
ClementPasteau Aug 25, 2025
2264135
Add explanation about changing student full names
4ian Aug 27, 2025
0847a44
Automatic update of the reference pages [skip ci]
Aug 27, 2025
2cfbd73
Fix formatting
4ian Aug 30, 2025
584d2e9
Add explanations for app id for provisioning profile on iOS
4ian Aug 30, 2025
2fdd42a
Automatic update of the reference pages [skip ci]
Aug 30, 2025
4e2463d
Automatic update of the reference pages [skip ci]
Aug 30, 2025
f8010e9
Automatic update of the reference pages [skip ci]
Aug 30, 2025
461f77e
Automatic update of the reference pages [skip ci]
Sep 3, 2025
eb14b51
Automatic update of the reference pages [skip ci]
Sep 5, 2025
ce6cb11
Automatic update of the reference pages [skip ci]
Sep 6, 2025
5630b9b
Automatic update of the reference pages [skip ci]
Sep 8, 2025
2c9e5da
[Functions] Move pages into folders (#335)
D8H Sep 11, 2025
ea005b2
Automatic update of the reference pages [skip ci]
Sep 16, 2025
e00b816
Auto Compress Images (#338)
github-actions[bot] Sep 18, 2025
2f46a97
Automatic update of the reference pages [skip ci]
Sep 21, 2025
a7d8829
Update AI Chat Cost (#342)
marcoscodas Sep 22, 2025
0df4421
Update allowance of free AI allocation with agent (#343)
marcoscodas Sep 22, 2025
08607a9
Update collaboration to avoid Edu confusion (#344)
marcoscodas Sep 22, 2025
6096235
Automatic update of the reference pages [skip ci]
Sep 24, 2025
c756104
[Functions] Add a page about asynchronous functions (#337)
D8H Sep 25, 2025
25e967d
Automatic update of the reference pages [skip ci]
Sep 26, 2025
9a4a43f
Automatic update of the reference pages [skip ci]
Sep 29, 2025
e6aae6a
Add doc for saving & loading the state (#348)
ClementPasteau Sep 29, 2025
10be591
Add screenshot for save (#349)
ClementPasteau Sep 29, 2025
901fd82
Fixed small bolding typo (#345)
marcoscodas Sep 29, 2025
187f663
Update domains to allow for the web-app
4ian Sep 29, 2025
0ac924b
Automatic update of the reference pages [skip ci]
Sep 30, 2025
26b45da
Automatic update of the reference pages [skip ci]
Oct 5, 2025
5aa33a4
[JS event] Add link to the list of objects and behaviors sub-classes …
D8H Oct 5, 2025
90b6e4d
Automatic update of the reference pages [skip ci]
Oct 7, 2025
8cf6db8
Automatic update of the reference pages [skip ci]
Oct 8, 2025
5102553
Automatic update of the reference pages [skip ci]
Oct 10, 2025
6ef07eb
Update Save State documentation
4ian Oct 10, 2025
881336d
Automatic update of the reference pages [skip ci]
Oct 10, 2025
7c84908
Upgrade material for mkdocs to latest version (#358)
4ian Oct 11, 2025
a025490
Add icons to left menu (#361)
4ian Oct 11, 2025
53b12c3
Fixed bad url in array and structures page (#354)
AnseloOriginal Oct 11, 2025
120b7a5
Update image auto compression
4ian Oct 11, 2025
07069ac
Revert "Auto Compress Images" (#364)
4ian Oct 11, 2025
e50e166
Automatic update of the reference pages [skip ci]
Oct 11, 2025
95f8e71
Improve Save State docs
4ian Oct 11, 2025
acc5c34
Fix formatting
4ian Oct 11, 2025
e7702c7
Automatic update of the reference pages [skip ci]
Oct 11, 2025
30d5727
Automatic update of the reference pages [skip ci]
Oct 11, 2025
98442f7
Automatic update of the reference pages [skip ci]
Oct 11, 2025
83ffd1e
Add video of 3D game using physics for Save State
4ian Oct 11, 2025
584410d
Migrate to uv (#367)
4ian Oct 12, 2025
724f33b
Move some pages
4ian Oct 12, 2025
1bcda99
Automatic update of the reference pages [skip ci]
Oct 12, 2025
f9e1685
Improve save state docs
4ian Oct 13, 2025
57c762a
Add Spine page in the documentation (#371)
Bouh Oct 20, 2025
979f3aa
Clarify programming knowledge requirement for events
4ian Oct 20, 2025
c3e8c46
Automatic update of the reference pages [skip ci]
Oct 22, 2025
220dffa
Add analytics for feedbacks (#373)
Bouh Oct 22, 2025
9ea34ec
Hide feedback on main page
4ian Oct 22, 2025
a0f5fe4
Automatic update of the reference pages [skip ci]
Oct 25, 2025
2d9677f
Update mkdocs.yml
Bouh Oct 26, 2025
62b1713
Merge branch 'main' of https://github.com/GDevelopApp/GDevelop-docume…
Bouh Oct 26, 2025
6164121
Update form link for the asset store
Bouh Oct 29, 2025
987901d
Remove reference to outdated page
4ian Oct 29, 2025
3f82299
Automatic update of the reference pages [skip ci]
Oct 29, 2025
d632249
[Spine] Fix reference link (#377)
D8H Oct 31, 2025
327dc78
[Randomness] Add a section about picking a random string (#378)
D8H Oct 31, 2025
3fd66af
Automatic update of the reference pages [skip ci]
Nov 6, 2025
ba3aed2
Automatic update of the reference pages [skip ci]
Nov 6, 2025
4ed1db2
docs: fix minor grammar and punctuation in contributing.md (#383)
ibarra617 Nov 6, 2025
a238b6f
Automatic update of the reference pages [skip ci]
Nov 11, 2025
9148ad1
Correct 'common consumers' to 'common culprits'
4ian Nov 22, 2025
616b874
Revise AI chat functionality and credit details
4ian Nov 26, 2025
8ba9956
Revise AI request credits and pricing information
4ian Nov 26, 2025
88ce7a8
Automatic update of the reference pages [skip ci]
Nov 28, 2025
0eb586c
Automatic update of the reference pages [skip ci]
Nov 28, 2025
d840bfc
Update interface menu
4ian Dec 1, 2025
fdd59f4
Automatic update of the reference pages [skip ci]
Dec 2, 2025
3d4c998
Automatic update of the reference pages [skip ci]
Dec 3, 2025
849bdea
Revising "Ask AI: Build your game with AI" page (#392)
LuniMoon Dec 3, 2025
d7a0a4b
Revising The "Build" page (#395)
LuniMoon Dec 4, 2025
0d5258c
Revising the "Ask" page (#396)
LuniMoon Dec 4, 2025
6a62914
Automatic update of the reference pages [skip ci]
Dec 11, 2025
0245f47
Automatic update of the reference pages [skip ci]
Dec 19, 2025
c29879c
Update Credits Page (#400)
LuniMoon Dec 19, 2025
3f83238
Auto Compress Images (#403)
github-actions[bot] Dec 19, 2025
99db33e
Automatic update of the reference pages [skip ci]
Dec 22, 2025
957130a
Improve custom object variant documentation (#411)
4ian Jan 8, 2026
19f690d
Automatic update of the reference pages [skip ci]
Jan 8, 2026
a6e233c
Add documentation for gdevelop-settings.yaml support (#416)
4ian Jan 12, 2026
a7b31c6
Automatic update of the reference pages [skip ci]
Jan 14, 2026
03f3f62
Automatic update of the reference pages [skip ci]
Jan 15, 2026
c6d54af
Add teacher instructions on how to use GDevelop for Education (#417)
marcoscodas Jan 15, 2026
0f44c02
Automatic update of the reference pages [skip ci]
Jan 15, 2026
40b6ae3
Automatic update of the reference pages [skip ci]
Jan 18, 2026
6e3a624
Automatic update of the reference pages [skip ci]
Jan 20, 2026
2589a2e
Update edu wiki to link teacher-guide and edu index (#420)
marcoscodas Jan 22, 2026
8e733c7
Expand education documentation with detailed guides and FAQs (#422)
4ian Jan 24, 2026
d68eab4
Automatic update of the reference pages [skip ci]
Jan 26, 2026
f4940ac
Automatic update of the reference pages [skip ci]
Jan 30, 2026
c24508e
Automatic update of the reference pages [skip ci]
Jan 31, 2026
8ad6602
Automatic update of the reference pages [skip ci]
Feb 4, 2026
101df2b
Automatic update of the reference pages [skip ci]
Feb 5, 2026
f57fbfe
Fix format for preferences file(#428)
malec-palec Feb 8, 2026
5ba743d
Add documentation for Else events (#431)
4ian Feb 9, 2026
04de29a
Automatic update of the reference pages [skip ci]
Feb 9, 2026
f910a70
Automatic update of the reference pages [skip ci]
Feb 10, 2026
25205ab
Automatic update of the reference pages [skip ci]
Feb 11, 2026
7f34e0a
Update Poki extension documentation (#430)
erikdubbelboer Feb 11, 2026
3573f33
Automatic update of the reference pages [skip ci]
Feb 12, 2026
06fab07
Automatic update of the reference pages [skip ci]
Feb 13, 2026
ad4a1e9
Automatic update of the reference pages [skip ci]
Feb 14, 2026
41dc1fe
Automatic update of the reference pages [skip ci]
Feb 15, 2026
ab2972c
Document local variables and loop counter support in loop events (#435)
4ian Feb 15, 2026
8b922bd
Automatic update of the reference pages [skip ci]
Feb 15, 2026
0ec93fb
Automatic update of the reference pages [skip ci]
Feb 16, 2026
28402a5
Add automated documentation updates (#436)
4ian Feb 16, 2026
f175fb3
Automatic update of the reference pages [skip ci]
Feb 16, 2026
ea22f53
Auto: Update documentation based on recent GDevelop changes (#437)
github-actions[bot] Feb 16, 2026
a7bdc21
Automatic update of the reference pages [skip ci]
Feb 16, 2026
7f1382b
Auto: Improve documentation (#438)
github-actions[bot] Feb 16, 2026
ee8bc04
Automatic update of the reference pages [skip ci]
Feb 16, 2026
e209727
Improve AI generated commit summaries (#440)
4ian Feb 16, 2026
913e521
Automatic update of the reference pages [skip ci]
Feb 16, 2026
9f41606
Auto: Improve documentation (#439)
github-actions[bot] Feb 16, 2026
225919a
Automatic update of the reference pages [skip ci]
Feb 16, 2026
d932e41
Improve automated workflows (#441)
4ian Feb 16, 2026
22fe97a
Automatic update of the reference pages [skip ci]
Feb 16, 2026
6d0405c
[Auto] [Improve] Enhanced pathfinding documentation with grid offsets…
github-actions[bot] Feb 16, 2026
ac6f744
Automatic update of the reference pages [skip ci]
Feb 16, 2026
40890d0
[Auto] [Improve] Enhanced tween behavior documentation with scale cen…
github-actions[bot] Feb 16, 2026
8f8032d
Automatic update of the reference pages [skip ci]
Feb 16, 2026
82111da
[Auto] [Improve] Enhanced UI and visual objects documentation with de…
github-actions[bot] Feb 16, 2026
bfbdca1
Automatic update of the reference pages [skip ci]
Feb 16, 2026
da4f063
Fix automated_updates_data.json
4ian Feb 16, 2026
4fd91cf
Automatic update of the reference pages [skip ci]
Feb 16, 2026
538bff6
[Auto] [Improve] Enhanced Spine object documentation with animation c…
github-actions[bot] Feb 16, 2026
9bd342c
Automatic update of the reference pages [skip ci]
Feb 16, 2026
1196148
Update update-docs-from-commits.js
4ian Feb 16, 2026
6264d61
Automatic update of the reference pages [skip ci]
Feb 16, 2026
51affb9
Automatic update of the reference pages [skip ci]
Feb 17, 2026
4c51f3e
[Auto] [Update] Document new diagnostic report feature with F7 shortc…
github-actions[bot] Feb 17, 2026
358d301
[Auto] [Improve] Enhanced bitmap text and shape painter documentation…
github-actions[bot] Feb 17, 2026
4a981e4
Automatic update of the reference pages [skip ci]
Feb 17, 2026
bfa7d06
Automatic update of the reference pages [skip ci]
Feb 18, 2026
d61a80f
Improve automated doc writing instructions
4ian Feb 18, 2026
3ba43f4
Improve automated doc writing instructions (2)
4ian Feb 18, 2026
070aeea
[Auto] [Update] No documentation changes needed for tooltip theme and…
github-actions[bot] Feb 18, 2026
7a5e446
Automatic update of the reference pages [skip ci]
Feb 18, 2026
1c640cb
[Auto] [Improve] Enhanced variables docs with bject variable guidance…
github-actions[bot] Feb 18, 2026
ae1411a
Automatic update of the reference pages [skip ci]
Feb 18, 2026
4b4970c
[Auto] [Improve] Enhanced platformer and top-down movement docs with …
github-actions[bot] Feb 18, 2026
dcb38a9
Automatic update of the reference pages [skip ci]
Feb 18, 2026
4589321
[Auto] [Improve] Enhanced sprite docs with blend modes, tint, flip, a…
github-actions[bot] Feb 18, 2026
f8aaa28
Automatic update of the reference pages [skip ci]
Feb 18, 2026
03e006c
[Auto] [Improve] Enhanced audio docs with fade, pitch, seek features …
github-actions[bot] Feb 18, 2026
fe5db0e
Automatic update of the reference pages [skip ci]
Feb 18, 2026
7c7e86a
Automatic update of the reference pages [skip ci]
Feb 19, 2026
225e67a
[Auto] [Update] Added Close Game Lobbies action to multiplayer lobbie…
github-actions[bot] Feb 19, 2026
a460eb1
Automatic update of the reference pages [skip ci]
Feb 19, 2026
5ca3821
Automatic update of the reference pages [skip ci]
Feb 20, 2026
273b112
[Auto] [Update] Document resource tab keyboard shortcuts and else-eve…
github-actions[bot] Feb 20, 2026
f69d451
Automatic update of the reference pages [skip ci]
Feb 20, 2026
015c731
Automatic update of the reference pages [skip ci]
Feb 21, 2026
0e85d6b
[Auto] [Update] Document 3D Physics minimum density requirement fix (…
github-actions[bot] Feb 21, 2026
0380fbd
[Auto] [Improve] Fixed async events doc truncation, while-event typo,…
github-actions[bot] Feb 21, 2026
aafea17
Automatic update of the reference pages [skip ci]
Feb 21, 2026
dab665c
Automatic update of the reference pages [skip ci]
Feb 22, 2026
11753fc
Automatic update of the reference pages [skip ci]
Feb 23, 2026
0c7e39f
[Auto] [Update] Document new dimension field for extensions in share …
github-actions[bot] Feb 23, 2026
a624a2d
[Auto] [Improve] Fixed iOS publishing docs, Android sideloading steps…
github-actions[bot] Feb 23, 2026
3893b4f
[Auto] [Improve] Fixed scene editor broken link, added layer effect e…
github-actions[bot] Feb 23, 2026
bd6bb1f
Automatic update of the reference pages [skip ci]
Feb 23, 2026
d56018a
Automatic update of the reference pages [skip ci]
Feb 24, 2026
60f3244
Update doc to mention reusing emails is not available (#475)
ClementPasteau Feb 24, 2026
8ee9b73
Automatic update of the reference pages [skip ci]
Feb 24, 2026
304d5bd
Add more explanations for the AI
4ian Feb 24, 2026
a204b7d
[Auto] [Update] Bumping last commit (#474)
github-actions[bot] Feb 24, 2026
84ee9ee
Automatic update of the reference pages [skip ci]
Feb 24, 2026
ebc3777
[Auto] [Improve] Fixed behavior lifecycle method names and updated co…
github-actions[bot] Feb 24, 2026
3dd24f7
Automatic update of the reference pages [skip ci]
Feb 24, 2026
244eef8
Automatic update of the reference pages [skip ci]
Feb 25, 2026
d6cc063
Update doc for ios build with cordova (#477)
ClementPasteau Feb 25, 2026
04442b6
Automatic update of the reference pages [skip ci]
Feb 25, 2026
b41cfdf
[Auto] [Improve] Added mouse buttons, wheel scrolling, storage value …
github-actions[bot] Feb 25, 2026
833d19c
Automatic update of the reference pages [skip ci]
Feb 25, 2026
e54e72c
Automatic update of the reference pages [skip ci]
Feb 26, 2026
36e84cb
Automatic update of the reference pages [skip ci]
Feb 27, 2026
ae7c7b9
Automatic update of the reference pages [skip ci]
Feb 28, 2026
b73cdd6
Automatic update of the reference pages [skip ci]
Mar 1, 2026
293b902
Automatic update of the reference pages [skip ci]
Mar 2, 2026
e369357
Automatic update of the reference pages [skip ci]
Mar 3, 2026
b6b030b
Automatic update of the reference pages [skip ci]
Mar 4, 2026
a24fe25
Automatic update of the reference pages [skip ci]
Mar 5, 2026
a3b4f3f
[Auto] [Update] Document For Each event ordering by expression and in…
github-actions[bot] Mar 5, 2026
287ed43
Automatic update of the reference pages [skip ci]
Mar 5, 2026
db6a3d9
Automatic update of the reference pages [skip ci]
Mar 6, 2026
dc88ee4
[Auto] [Improve] Updated network docs with async requests, HTTP metho…
github-actions[bot] Mar 6, 2026
be958e0
Automatic update of the reference pages [skip ci]
Mar 6, 2026
8c6e51e
Automatic update of the reference pages [skip ci]
Mar 7, 2026
0588f0d
Automatic update of the reference pages [skip ci]
Mar 8, 2026
1b4e06d
Automatic update of the reference pages [skip ci]
Mar 9, 2026
1d19560
Automatic update of the reference pages [skip ci]
Mar 10, 2026
30aeda0
[Auto] [Update] Added docs for global search, function folders, AI pl…
github-actions[bot] Mar 10, 2026
495b68d
[Auto] [Improve] Filled in missing 3D Physics Engine concepts: shapes…
github-actions[bot] Mar 10, 2026
d6fa351
Automatic update of the reference pages [skip ci]
Mar 10, 2026
640ce79
Automatic update of the reference pages [skip ci]
Mar 11, 2026
7e4557c
[Auto] [Update] Added 'Centered on Z only' center mode option to 3D m…
github-actions[bot] Mar 11, 2026
e2931f1
Automatic update of the reference pages [skip ci]
Mar 11, 2026
21fd156
Automatic update of the reference pages [skip ci]
Mar 12, 2026
56a49d9
[Auto] [Update] Updated education docs to reflect inviting existing a…
github-actions[bot] Mar 12, 2026
e8b95eb
Automatic update of the reference pages [skip ci]
Mar 12, 2026
de8d04d
Automatic update of the reference pages [skip ci]
Mar 13, 2026
e0bd6c4
[Auto] [Improve] Fixed player authentication docs and clarified inven…
github-actions[bot] Mar 13, 2026
8e0c766
Automatic update of the reference pages [skip ci]
Mar 13, 2026
aa9134b
Automatic update of the reference pages [skip ci]
Mar 14, 2026
6442655
Automatic update of the reference pages [skip ci]
Mar 15, 2026
b3b9e7e
Automatic update of the reference pages [skip ci]
Mar 16, 2026
8070037
[Auto] [Update] No changes (#516)
github-actions[bot] Mar 16, 2026
edf133d
Fix link
4ian Mar 16, 2026
2f12bd3
Automatic update of the reference pages [skip ci]
Mar 16, 2026
6da3f4a
[Auto] [Improve] Added string replace, JSON conversion, time scale, a…
github-actions[bot] Mar 16, 2026
3ef8ada
Automatic update of the reference pages [skip ci]
Mar 16, 2026
3e4106c
Automatic update of the reference pages [skip ci]
Mar 17, 2026
59bea9b
Automatic update of the reference pages [skip ci]
Mar 18, 2026
6c5ebf7
[Auto] [Update] Update (#526)
github-actions[bot] Mar 18, 2026
72ed441
Automatic update of the reference pages [skip ci]
Mar 18, 2026
e6e75dc
Automatic update of the reference pages [skip ci]
Mar 19, 2026
f450cc4
[Auto] [Update] No documentation updates needed for recent bug fix an…
github-actions[bot] Mar 19, 2026
b222617
Automatic update of the reference pages [skip ci]
Mar 19, 2026
800a8d9
Automatic update of the reference pages [skip ci]
Mar 20, 2026
578bedf
Automatic update of the reference pages [skip ci]
Mar 21, 2026
017a157
[Auto] [Update] Add Ctrl+K as secondary command palette shortcut (#530)
github-actions[bot] Mar 21, 2026
c5145b0
Automatic update of the reference pages [skip ci]
Mar 21, 2026
a43c0e0
Automatic update of the reference pages [skip ci]
Mar 22, 2026
c9ee2a9
Automatic update of the reference pages [skip ci]
Mar 23, 2026
97a30ec
Automatic update of the reference pages [skip ci]
Mar 24, 2026
7f71830
[Auto] [Improve] Fix device sensor units, typo, and broken wiki link …
github-actions[bot] Mar 24, 2026
8d0b5e1
Automatic update of the reference pages [skip ci]
Mar 24, 2026
d627db8
Automatic update of the reference pages [skip ci]
Mar 25, 2026
203baba
Automatic update of the reference pages [skip ci]
Mar 26, 2026
214e73d
Automatic update of the reference pages [skip ci]
Mar 27, 2026
601687f
Automatic update of the reference pages [skip ci]
Mar 28, 2026
9d54b39
Automatic update of the reference pages [skip ci]
Mar 29, 2026
e323db5
Automatic update of the reference pages [skip ci]
Mar 30, 2026
d7eca24
Automatic update of the reference pages [skip ci]
Mar 31, 2026
9b8b2b8
[Auto] [Update] Document JS type error preference and extended Diagno…
github-actions[bot] Mar 31, 2026
40dbb4e
Automatic update of the reference pages [skip ci]
Mar 31, 2026
357fdaf
Automatic update of the reference pages [skip ci]
Apr 1, 2026
a51bbfe
Fix formatting
4ian Apr 1, 2026
a93973d
Automatic update of the reference pages [skip ci]
Apr 1, 2026
8224acb
Automatic update of the reference pages [skip ci]
Apr 2, 2026
fae730c
Update index.md
reyamesh Apr 2, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 3 additions & 0 deletions .github/workflows/calibreapp-image-actions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ jobs:
# For non-Pull Requests, run in compressOnly mode and we'll PR after.
compressOnly: ${{ github.event_name != 'pull_request' }}
ignorePaths: 'docs/es/**,docs/de/**,docs/fr/**,docs/ru/**,docs/sl/**'
# Avoid progressive degradation of quality
pngQuality: '100'
minPctChange: '30'
- name: Create Pull Request
# If it's not a Pull Request then commit any changes as a new PR.
if: |
Expand Down
115 changes: 115 additions & 0 deletions .github/workflows/improve-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
# ============================================================================
# Improve Documentation (AI-driven)
# ============================================================================
# Runs daily (or on demand). Pulls the GDevelop repo, reads what has already
# been improved in automated_updates_data.json, and uses an AI agent to
# improve a DIFFERENT aspect of the documentation each run.
#
# To switch from Claude Code to Codex:
# 1. Change AI_PROVIDER to "codex"
# 2. Comment out the "Install Claude Code" step and uncomment "Install Codex"
# 3. Swap the API key secrets (comment ANTHROPIC_API_KEY, uncomment OPENAI_API_KEY)
# ============================================================================

name: "Auto: Improve documentation"

on:
schedule:
- cron: "0 10 * * *" # Every day at 10:00 UTC (offset from the other workflow)
workflow_dispatch: # Manual trigger
# pull_request: # For testing in PRs

permissions:
contents: write
pull-requests: write

jobs:
improve-docs:
runs-on: ubuntu-latest
if: github.repository == 'GDevelopApp/GDevelop-documentation'
timeout-minutes: 20

steps:
# ── Checkout this documentation repo ──────────────────────────────
- name: Checkout documentation repo
uses: actions/checkout@v4
with:
fetch-depth: 0

# ── Node.js ───────────────────────────────────────────────────────
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: "20"

# ── Install AI CLI ────────────────────────────────────────────────
- name: Install Claude Code
run: npm install -g @anthropic-ai/claude-code

# Uncomment below (and comment above) to use Codex instead:
# - name: Install Codex
# run: npm install -g @openai/codex

# ── Generate a random suffix for the branch name ─────────────────
- name: Generate branch suffix
id: suffix
run: echo "value=$(openssl rand -hex 2)" >> "$GITHUB_OUTPUT"

# ── Run the improvement script ────────────────────────────────────
- name: Improve documentation
id: improve
env:
AI_PROVIDER: "claude" # Change to "codex" to use Codex
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
# OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
run: |
node scripts/improve-docs.js

# Pass the AI summary to subsequent steps
if [ -f /tmp/ai_summary.txt ]; then
delimiter="EOF_$(openssl rand -hex 8)"
{
echo "summary<<${delimiter}"
cat /tmp/ai_summary.txt
echo ""
echo "${delimiter}"
} >> "$GITHUB_OUTPUT"
fi

# Pass the AI-generated PR title to subsequent steps
if [ -f /tmp/ai_pr_title.txt ]; then
delimiter="EOF_$(openssl rand -hex 8)"
{
echo "pr_title<<${delimiter}"
cat /tmp/ai_pr_title.txt
echo ""
echo "${delimiter}"
} >> "$GITHUB_OUTPUT"
else
echo "pr_title=[Auto] [Improve] Documentation improvement" >> "$GITHUB_OUTPUT"
fi

# ── Create Pull Request ───────────────────────────────────────────
- name: Create Pull Request
uses: peter-evans/create-pull-request@v7
with:
token: ${{ secrets.GITHUB_TOKEN }}
commit-message: ${{ steps.improve.outputs.pr_title }}
title: ${{ steps.improve.outputs.pr_title }}
body: |
This PR was automatically generated by the **Improve documentation** workflow.

An AI coding agent inspected the [GDevelop](https://github.com/4ian/GDevelop) codebase
and the existing documentation, then chose an aspect to improve.

The AI agent summary is:
> ${{ steps.improve.outputs.summary }}

The updated `automated_updates_data.json` tracks what was improved so future
runs will pick a different area.

**Please review the changes carefully before merging.**
base: main
branch: auto/improve-docs-${{ steps.suffix.outputs.value }}
delete-branch: true
labels: automated,improvement
126 changes: 126 additions & 0 deletions .github/workflows/update-docs-from-commits.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
# ============================================================================
# Update Documentation from GDevelop Commits
# ============================================================================
# Runs daily (or on demand). Pulls the GDevelop repo, inspects recent commits
# since the last tracked commit, and uses an AI agent (Claude Code by default,
# Codex as an alternative) to update the docs accordingly.
#
# To switch from Claude Code to Codex:
# 1. Change AI_PROVIDER to "codex"
# 2. Comment out the "Install Claude Code" step and uncomment "Install Codex"
# 3. Swap the API key secrets (comment ANTHROPIC_API_KEY, uncomment OPENAI_API_KEY)
# ============================================================================

name: "Auto: Update docs from GDevelop commits"

on:
schedule:
- cron: "0 8 * * *" # Every day at 08:00 UTC
workflow_dispatch: # Manual trigger
# pull_request: # For testing in PRs

permissions:
contents: write
pull-requests: write

jobs:
update-docs:
runs-on: ubuntu-latest
if: github.repository == 'GDevelopApp/GDevelop-documentation'
timeout-minutes: 20

steps:
# ── Checkout this documentation repo ──────────────────────────────
- name: Checkout documentation repo
uses: actions/checkout@v4
with:
fetch-depth: 0

# ── Node.js ───────────────────────────────────────────────────────
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: "20"

# ── Install AI CLI ────────────────────────────────────────────────
- name: Install Claude Code
run: npm install -g @anthropic-ai/claude-code

# Uncomment below (and comment above) to use Codex instead:
# - name: Install Codex
# run: npm install -g @openai/codex

# ── Generate a random suffix for the branch name ─────────────────
- name: Generate branch suffix
id: suffix
run: echo "value=$(openssl rand -hex 2)" >> "$GITHUB_OUTPUT"

# ── Run the update script ─────────────────────────────────────────
- name: Update documentation from recent commits
id: update
env:
AI_PROVIDER: "claude" # Change to "codex" to use Codex
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
# OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
run: |
node scripts/update-docs-from-commits.js

# Pass the AI summary and commit log to subsequent steps
if [ -f /tmp/ai_summary.txt ]; then
delimiter="EOF_$(openssl rand -hex 8)"
{
echo "summary<<${delimiter}"
cat /tmp/ai_summary.txt
echo ""
echo "${delimiter}"
} >> "$GITHUB_OUTPUT"
fi
if [ -f /tmp/commit_log.txt ]; then
delimiter="EOF_$(openssl rand -hex 8)"
{
echo "commits<<${delimiter}"
cat /tmp/commit_log.txt
echo ""
echo "${delimiter}"
} >> "$GITHUB_OUTPUT"
fi

# Pass the AI-generated PR title to subsequent steps
if [ -f /tmp/ai_pr_title.txt ]; then
delimiter="EOF_$(openssl rand -hex 8)"
{
echo "pr_title<<${delimiter}"
cat /tmp/ai_pr_title.txt
echo ""
echo "${delimiter}"
} >> "$GITHUB_OUTPUT"
else
echo "pr_title=[Auto] [Update] Documentation update from commits" >> "$GITHUB_OUTPUT"
fi

# ── Create Pull Request ───────────────────────────────────────────
- name: Create Pull Request
uses: peter-evans/create-pull-request@v7
with:
token: ${{ secrets.GITHUB_TOKEN }}
commit-message: ${{ steps.update.outputs.pr_title }}
title: ${{ steps.update.outputs.pr_title }}
body: |
This PR was automatically generated by the **Update docs from GDevelop commits** workflow.

An AI coding agent analysed recent commits in [4ian/GDevelop](https://github.com/4ian/GDevelop)
and updated the documentation to reflect user-facing changes.

### GDevelop commits covered
```
${{ steps.update.outputs.commits }}
```

### The AI agent summary is:
${{ steps.update.outputs.summary }}

**Please review the changes carefully before merging.**
base: main
branch: auto/update-docs-from-commits-${{ steps.suffix.outputs.value }}
delete-branch: true
labels: automated,update
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
dokuwiki2wikijs/__pycache__
.DS_Store
site
site
scripts/node_modules/
1 change: 1 addition & 0 deletions AGENTS.md
10 changes: 10 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Important Writing Style And Architecture Constraints

- Do NOT document non-user-facing implementation details. Focus only on information
that is relevant to users creating games with GDevelop, not internal engine behavior.
- Do NOT list all actions/conditions in a list or table: the reference documentations are already
automatically generated for this.
- Do not specify the default values. Don't feel forced to list all the properties of a
behavior/object/condition/action: prefer to explain use cases, examples and how it's useful
for the end user which will create a game with it.
- Do not explain standard default/shortcuts (the UI is supposed to make this clear already).
12 changes: 6 additions & 6 deletions CONTRIBUTE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

Thank you for investing your time in contributing to GDevelop's documentation! Any contribution you make will be reflected on wiki.gdevelop.io ✨.

In this guide you will get an overview of the contribution workflow.
In this guide, you will get an overview of the contribution workflow.

## Make a contribution

To make a contribution, you shall follow those steps:
To make a contribution, follow those steps:

1. [Fork this repository](https://docs.github.com/fr/get-started/quickstart/fork-a-repo)
2. [Install the project](#installation)
3. [Find an issue that you can resolve](https://github.com/GDevelopApp/GDevelop-documentation/issues)
4. [Open a Pull Request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)
5. Once your Pull Request is merged, the documentation will be automatically be updated with your changes (a few minutes for changes to take effect)
5. Once your Pull Request is merged, the documentation will automatically be updated with your changes (a few minutes for changes to take effect)

## Installation

Expand All @@ -27,15 +27,15 @@ First install:
Run:

```sh
poetry install
poetry install --no-root
```

### Run the project

```sh
mkdocs serve
poetry run mkdocs serve
# Or, for faster reload after changes:
mkdocs serve --dirtyreload
poetry run mkdocs serve --dirtyreload
```

This will run the documentation on http://localhost:8000.
Expand Down
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,17 @@ This repository holds [the official documentation](https://wiki.gdevelop.io) for

## Getting Started

| ❔ I want to... | 🚀 What to do |
| -------------------------------------------- | --------------------------------------------------------------------------------- |
| Improve or add articles to the documentation | Head over to [this README](./SYNTAX.md) to understand the syntax of the documentation.|
| Bring improvements to the documentation interface | Head over to [this README](./CONTRIBUTE.md) to understand how this repository works. |
| ❔ I want to... | 🚀 What to do |
| ------------------------------------------------- | -------------------------------------------------------------------------------------- |
| Improve or add articles to the documentation | Head over to [this README](./SYNTAX.md) to understand the syntax of the documentation. |
| Bring improvements to the documentation interface | Head over to [this README](./CONTRIBUTE.md) to understand how this repository works. |

## Contribute to this repository

Install [uv](https://github.com/astral-sh/uv) for Python. Then:

```bash
uv sync
uv run mkdocs serve # To run the documentation locally and see changes.
uv run mkdocs build # To build for deployment on a static hosting.
```
Loading