Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Separate pages for environments #1959

Open
badosu opened this issue Feb 17, 2025 · 0 comments
Open

[Docs] Separate pages for environments #1959

badosu opened this issue Feb 17, 2025 · 0 comments
Assignees
Labels
area: documentation Improvements or additions to documentation

Comments

@badosu
Copy link
Collaborator

badosu commented Feb 17, 2025

Recoil has many different environment on which games can be programmed in Lua:

  • LuaIntro (For loading screens before games)
  • LuaMenu (For lobbies built in lua)
  • LuaUI (Unsynced)
  • Unsynced LuaRules (Shares most of API with LuaUI)
  • Synced LuaRules

We want to be able to offer a way for gamedevs to find what APIs are available on which environment they're coding for. Spring Wiki (which was manually curated) and the previous LDoc (which was per file) did not fulfill all these but they had segmented pages for Unsynced and Synced environments (which is the brunt of gamedev experience).

Ideally we'd have all these covered, but just Synced/Unsynced would be a big step forwards from current.

@badosu badosu added the area: documentation Improvements or additions to documentation label Feb 17, 2025
@rhys-vdw rhys-vdw self-assigned this Feb 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants