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

Improve docs/supplemental files for plugins #5047

Merged
merged 3 commits into from Dec 29, 2023

Conversation

Nerixyz
Copy link
Contributor

@Nerixyz Nerixyz commented Dec 28, 2023

While trying to add docs for plugins on the wiki, I noticed some issues in the plugin docs:

  • The JSON schema didn't allow $schema as a key.
  • The TypeScript types contained the wrong event type.
  • register_callback wasn't documented at all.
  • No Lua metadata for plugins was present. LuaLS seems to be the most common language server.

Copy link
Member

@pajlada pajlada left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me 👍
Would be cool if the docs/plugin-meta.lua file could be auto-generated since it's a bit of a duplicate of LuaAPI.hpp

@pajlada pajlada requested a review from Mm2PL December 29, 2023 14:58
@Mm2PL
Copy link
Collaborator

Mm2PL commented Dec 29, 2023

Would be cool if the docs/plugin-meta.lua file could be auto-generated since it's a bit of a duplicate of LuaAPI.hpp

I can work on that. In the mean time this PR is a good step towards that.

@Mm2PL Mm2PL enabled auto-merge (squash) December 29, 2023 16:56
@Mm2PL Mm2PL merged commit 60d79ef into Chatterino:master Dec 29, 2023
20 checks passed
@Nerixyz Nerixyz deleted the docs/plugins branch December 29, 2023 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants