Skip to content

Moved Lua & Shader API Reference from Wiki to Repository#657

Merged
adriengivry merged 5 commits intomainfrom
feature/better_builtin_doc
Apr 6, 2026
Merged

Moved Lua & Shader API Reference from Wiki to Repository#657
adriengivry merged 5 commits intomainfrom
feature/better_builtin_doc

Conversation

@adriengivry
Copy link
Copy Markdown
Member

@adriengivry adriengivry commented Apr 6, 2026

Description

GitHub wiki's being fairly limited and not very collaborative, this PR moves the scripting & shader API (Lua & GLSL related documentation) directly to the Overload repository.

This will allow:

  • Collaborators to update the API alongside their PRs
  • Version the API alongside the engine (e.g. Overload 1.8 might have a different Lua API than 1.9)

Note

Tutorials will remain in the Wiki for now, as they are typically image-heavy, which we want to keep out of the repository.

To-Do

  • Update engine "Help" menu in the menu bar to point to the repository's API/ folder (based on tag of the current version)
  • Update Wiki to have a "Depreciation notice" for its scripting API

Related Issue(s)

Fixes #(issue number)

Review Guidance

Write here.

Screenshots/GIFs

Write here.

Checklist

  • My code follows the project's code style guidelines
  • I have commented my code, particularly in hard-to-understand areas
  • I have updated the documentation accordingly
  • My changes don't generate new warnings or errors

@adriengivry adriengivry force-pushed the feature/better_builtin_doc branch 5 times, most recently from 015c85c to 71e9659 Compare April 6, 2026 15:12
@adriengivry adriengivry self-assigned this Apr 6, 2026
@adriengivry adriengivry added Documentation Improvements or additions to documentation Refactoring Something that needs a refactoring labels Apr 6, 2026
@adriengivry adriengivry force-pushed the feature/better_builtin_doc branch 2 times, most recently from a425e4d to 5260988 Compare April 6, 2026 15:41
@adriengivry adriengivry force-pushed the feature/better_builtin_doc branch from 5260988 to eada31a Compare April 6, 2026 15:44
@adriengivry adriengivry changed the title [WIP] Built-in doc [WIP] Built-in API Reference Apr 6, 2026
@adriengivry adriengivry changed the title [WIP] Built-in API Reference [WIP] Added Built-in API Reference Apr 6, 2026
@adriengivry adriengivry changed the title [WIP] Added Built-in API Reference [WIP] Moved Lua & Shader API Reference from Wiki to Repository Apr 6, 2026
@adriengivry adriengivry marked this pull request as ready for review April 6, 2026 16:54
@adriengivry adriengivry merged commit 49aa60d into main Apr 6, 2026
2 checks passed
@adriengivry adriengivry deleted the feature/better_builtin_doc branch April 6, 2026 16:54
@adriengivry adriengivry changed the title [WIP] Moved Lua & Shader API Reference from Wiki to Repository Moved Lua & Shader API Reference from Wiki to Repository Apr 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation Refactoring Something that needs a refactoring

Development

Successfully merging this pull request may close these issues.

1 participant