16 Godot New Version Doc Update

Jori edited this page 2026-05-26 12:28:31 +00:00

Table of Contents

• 0. Preparation
• 1. Get Godot Docs From Source
• 2. Generate Doc Page Structure
• 3. Configure Generator
• 4. Ensure Max Pages Creation
• 5. Run Updater for the Generator
• 6. Update Index
• 7. Update Doc Index Selector
• 8. Update site map exclusions
• 9. Update links

0. Preparation

• The generation takes 10-30 mins.

1. Get Godot Docs From Source

• Download the newest godot docs by pulling the current version: C:/rokojori/godot-projects/godot

2. Generate Doc Page Structure

• Create the following directories:
  source/rokojori.com/pages/en/labs/godot/docs/version/godot
  source/rokojori.com/pages/en/labs/godot/docs/version/rokojori

3. Configure Generator

• Open GodotDocsGenerator.ts
  
• Set GodotDocsGenerator.version = "X.X"
  
• Ensure to updateGodot and createDocIndex
• Ensure the template for X.X as exists source/_rokojori.com/_dev-tools/godot-docs-generator/class-doc-template-X.X.html

4. Ensure Max Pages Creation

• npm run pages-rokojori all

5. Run Updater for the Generator

• Ensure the updater has Godot Doc creation enabled:
  source/_rokojori.com/_dev-tools/updater/main.ts
  npm run update-rokojori
  

6. Update Index

change pages/labs/godot/docs/X.X/index to create the index

7. Update Doc Index Selector

• Open GodotDocsIndexSelector.ts
  Add the new GodotDocsIndex_X_X

8. Update site map exclusions

• open pages-settings.json

9. Update links

• replace with regex