Plugin API documentations?

[a9udn9u]

Sorry if this has been asked, I tried searching for documentations but all I can find is the Get Started post, it helped me create a plugin but it didn’t cover topics such as what APIs are available. So, are there documents at all?

Thanks!

[net_deamon]

Api documentation is available at
http://docs.discourse.org

[a9udn9u]

Discourse API doc is not what I’m requesting. I was thinking about something like Chrome plugin development docs or WordPress plugin development docs. For example when I read the Beginner’s Guide to Creating Discourse Plugins, I have questions like what are other special properties and callbacks does Discourse recognize in the default module? or what parameters are passed into the initialize() method? Neither the guide nor docs.discourse.org answered those questions.

[net_deamon]

As discourse uses ember in frontend and rails in backend, you can browse their respective docs to know how to create components, or controllers, etc.

That being said, you can go through the code of discourse to learn how they are doing things.

I had asked similar question long time back… See if the answers given here help you.

How do you learn to build Discourse plugins?

How do you guys build such amazing plugins with discourse ? I am not even able to integrate a custom field to discourse topic using a custom plugin. Is there any documentation that can help me build an advanced plugin like this? The introduction series to Discourse plugins only touches the plugin outlet part. But how do I take that and integrate it with Discourse? I tried reading the source code of Discourse plugins, as Jeff suggested, But I only have questions like what does add_to_serializer …

[erlend_sh (Erlend Sogge Heggen)]

@a9udn9u

I have questions like what are other special properties and callbacks does Discourse recognize in the default module? or what parameters are passed into the initialize() method? Neither the guide nor docs.discourse.org answered those questions.

Then those questions are probably good candidates for dev

[bcartwri96 (Ben Cartwright)]

Поднимаю эту тему, так как на неё не ответили

[pacharanero (Marcus Baw)]

@bcartwri96 Я считаю, что суть в том, что для API плагинов Discourse практически отсутствует исчерпывающая документация.

На Meta есть разрозненная информация, например, Developing Discourse Plugins - Part 1 - Create a basic plugin, но, похоже, нет полного справочника по API. Хотя часть того, что происходит, является стандартным Ember или Rails, существует огромный пласт специфики, который представляет собой чистые соглашения Discourse.

Со временем было бы здорово, если бы сообщество взялось за создание Руководства разработчика Discourse, которое заполнило бы этот пробел. Мы уже начали это делать в виде фрагментов инструкций HOWTO по адресу Pavilion, и, надеюсь, эта работа послужит начальным фундаментом для разработки более полного справочного руководства.

[fzngagan (Faizaan Gagan)]

Посмотрите этот файл. Большинство методов кратко задокументированы
https://github.com/discourse/discourse/blob/master/app/assets/javascripts/discourse/app/lib/plugin-api.js

[alxndr (Alexander)]

Этот файл перемещён в blob/main/app/assets/javascripts/discourse/app/lib/plugin-api.gjs