misskey-dev / misskey-hub-next

Website for Misskey since Dec 2023. Built on Nuxt. I18n is available on Crowdin.
https://misskey-hub.net/
GNU Affero General Public License v3.0
132 stars 44 forks source link

Page Plugin API, are examples actual? #251

Closed tassoman closed 23 hours ago

tassoman commented 6 days ago

šŸ’” Summary

I have feeling Plugin examples are not actual updated with latest AiScript availability in misskey. Also, default examples doesn't work.

šŸ„° Expected Behavior

As visitor, I'd like to cut and paste a complete plugin example from misskey-hub to my profile, and see it working without writing any line of code. (maybe I will write by myself after seeing a complete working example)

šŸ¤¬ Actual Behavior

I made cut and paste of register_note_post_interruptor but, writing a note I got an error. More, the "header/configuration" part example is missing the mandatory AiScript notation /// @ 0.19.0 at first row. Finally, all code parts are divided into snippets, there isn't a complete plugin example or downloadable (maybe by using import feature)

šŸ“ Steps to Reproduce

  1. visit https://misskey-hub.net/ja/docs/for-developers/plugin/plugin-api-reference/#pluginregister_note_post_interruptorfn
  2. copy text in code boxes
  3. paste into your profile settings
  4. see unknown errors

šŸ’» Environment

* any

Do you want to address this bug yourself?

kakkokari-gtyih commented 5 days ago

These are all snippets, and (as mentioned in the documentation,) plugin needs metadata block.

Complete examples of plugin is a good idea! I'll add them soon.