Documentation web scraped and aggregated to help the ai agents
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-01 20:08:41 -05:00
.github/workflows Update .github/workflows/sync-godot-docs.yml 2026-11-02 00:46:04 +00:00
Bevy-Documentation Add Common Cryptic Bevy Compiler Errors Cookbook & Section Links 2026-10-20 18:33:11 -04:00
Godot-Documentation Add KidsCanCode recipes, Catlike Coding tutorials, 139 official Godot demos, and Awesome-Godot catalogs 2026-11-01 20:08:34 -05:00
.gitignore Add Godot 4.7 documentation hub and daily sync GitHub Action 2026-11-01 19:38:37 -05:00
README.md Add KidsCanCode recipes, Catlike Coding tutorials, 139 official Godot demos, and Awesome-Godot catalogs 2026-11-01 20:08:34 -05:00

📚 Game Engine Documentation Knowledge Hub

Offline-Queryable, Cross-Linked Documentation for Bevy (Rust) & Godot Engine

Welcome to the central game development documentation repository. This workspace provides complete, structured, offline-queryable Markdown references for both the Bevy Rust Game Engine and Godot Engine, designed for both human developers and AI coding assistants.


🧭 Master Documentation Hubs

Engine Active Version Master Index Scope & Coverage
🦀 Bevy Engine (Rust) 0.15+ Bevy-Documentation/INDEX.md Official Bevy Book (40 docs), Unofficial Cheat Book (138 guides), 9 Game Tutorials, 150+ Official Examples, 366+ Community Crates, 98 Open-Source Games, & Migration Guides
🤖 Godot Engine 4.7 (Stable) Godot-Documentation/INDEX.md Official Manual & Tutorials (511 docs), 1,078 Built-in Classes (9 Catalogs), KidsCanCode 4.x Recipes (101 guides), Catlike Coding Godot 4 Series (31 guides), 110+ Official Demo Projects, 14 Complete Game Codebases, & Awesome-Godot

🗂️ Repository Layout

Documentation/
├── .github/
│   └── workflows/
│       └── sync-godot-docs.yml         # Daily automated version check & incremental sync
├── Bevy-Documentation/                 # 🦀 Bevy 0.15+ Rust Game Engine Knowledge Hub
│   ├── 00_getting_started/             # Setup, cargo optimizations, compiler error cookbook
│   ├── 01_core_ecs_architecture/       # Official Bevy Book (ECS, Schedules, Rendering, Assets)
│   ├── 02_tutorials/                   # 9 End-to-end game tutorials (Snake, Chess, Roguelike, etc.)
│   ├── 03_deep_dives_and_guides/       # Networking, GGRS rollback, render pipelines, archetypes
│   ├── 04_bevy_cheat_book/             # The Unofficial Bevy Cheat Book (138 chapters)
│   ├── 05_official_examples/           # 11 Domain catalogs indexing 150+ official Bevy examples
│   ├── 06_ecosystem_and_plugins/       # Physics (Avian/Rapier), UI, Input & 366 community crates
│   ├── 07_migrations_and_history/      # Migration guides (0.11 -> 0.15+) & breaking changes table
│   ├── 08_game_showcase_and_templates/ # 98 Open-source games, 13 tools & 10 starter templates
│   ├── tools/                          # Bevy ingestion & index maintenance scripts
│   ├── INDEX.md                        # Bevy Master Index
│   └── manifest.json                   # Bevy asset registry
└── Godot-Documentation/                # 🤖 Godot 4.7 (Stable) Game Engine Knowledge Hub
    ├── 00_getting_started/             # About Godot, FAQ, Step-by-Step, First 2D & 3D Games
    ├── 01_core_and_scripting/          # Best Practices, GDScript, C#/.NET, GDExtension, Editor
    ├── 02_2d_and_3d_development/       # 2D, TileMaps, 3D, Global Illumination, Animation, Assets
    ├── 03_physics_navigation_and_math/ # 2D/3D Physics, Raycasting, Navigation, Vector Math
    ├── 04_rendering_shaders_and_ui/    # Renderers, Shading Language, Canvas/Spatial/Compute, UI
    ├── 05_systems_io_audio_networking_xr/ # Audio, Input, File/Data I/O, Multiplayer, i18n, OpenXR
    ├── 06_export_performance_and_engine/  # Exporting, Profiling/Optimization, Plugins, Engine C++
    ├── 07_migrations_and_history/      # Upgrade guides (Godot 3 -> 4.0 through 4.7)
    ├── 08_class_reference_and_community/  # 1,078 Built-in Classes (9 Catalogs) & Community
    ├── 09_godot_recipes_and_tutorials/ # KidsCanCode 4.x Recipes (101) & Catlike Coding Series (31)
    ├── 10_official_demos_and_community_games/ # 110+ Official Demos, 14 Full Game Codebases & Awesome-Godot
    ├── tools/                          # Godot scraper, RST->MD converter & incremental diff engine
    ├── INDEX.md                        # Godot Master Index
    └── manifest.json                   # Godot version tracker & per-page SHA-256 registry

🚀 Quick Jump by Engine

🦀 Bevy Engine (Bevy-Documentation/)

🤖 Godot Engine (Godot-Documentation/)


🔄 Automated Documentation Synchronization

The Sync Godot Documentation workflow runs daily at 06:00 UTC (and supports manual dispatch):

  1. Version Check Gate: Runs python Godot-Documentation/tools/ingest_godot_docs.py --check-only to compare the live version on docs.godotengine.org/en/stable against Godot-Documentation/manifest.json.
  2. Fast Skip: If the version has not changed, the workflow exits immediately without scraping.
  3. Incremental Diff Sync / Full Rescrape: When a new version is detected (or when triggered manually with force_update or full_rescrape), it compares per-page SHA-256 hashes, updates modified/added/removed guides and class catalogs, regenerates Godot-Documentation/INDEX.md, and commits the changes to main.