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

Use lovr-docs for lovr definitions; #220

Closed
wants to merge 2 commits into from

Conversation

bjornbytes
Copy link

@bjornbytes bjornbytes commented Feb 21, 2025

Hello! The lovr definitions are very old and it isn't clear how to update them. I added a LuaCATS generator to lovr's main documentation repo and set up a GH actions script to keep them in sync with the docs and publish them on a cats branch.

Could we change the lovr addon here to point at these new up to date definition files? I can open a PR here to bump the submodule whenever LÖVR does a new release, and people that want up-to-date definitions can always grab fresh ones from lovr-docs.

@carsakiller carsakiller added the Addon Update An update for an existing addon label Feb 26, 2025
@carsakiller
Copy link
Collaborator

I have just now seen your issue on the LuaCATS/lovr repo, sorry. Awesome work here! If you want, I can add you as a maintainer of the LuaCATS/lovr repo, or I will probably just archive it and point to yours. Like you said, it is quite old. Let me know what you would like to do 🙂

@bjornbytes
Copy link
Author

Hm, it might be better to use the existing LuaCATS/lovr repository actually!

I realized that the separate cats branch in lovr-docs can't use branches/tags for the definition files, which causes some issues. The cats branch contains all of the latest changes from the dev docs, so there is no way to fix issues for stable releases without bringing in all of the dev changes. We'd have to have cats-dev and cats-stable branches or something, and it gets very messy.

If you want, you can add me as a contributor on LuaCATS/lovr and I can copy the lovr-docs definition files over for now. Eventually I could set up some automation to push to different branches automatically as the different lovr-docs branches are changed.

Thanks for the response!

@carsakiller
Copy link
Collaborator

Invited!

@bjornbytes
Copy link
Author

Thanks, I think we can close this then.

@bjornbytes bjornbytes closed this Feb 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Addon Update An update for an existing addon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants