Documentation for developers

Project Lead 2029 posts

Aug. 1, 2022, 9:12 p.m. Aug. 1, 2022, 9:12 p.m.

I've decided to write developer documentation for Misago together with code. This documentation is not hosted on any dedicated site, but it's kept as directory with text files right next to Misago's code:

github.com/rafalp/Misago/blob/starlette/docs/index.md

So far there's only basic plugins reference, hooks reference and documentation for database. I'm hoping that documentation will be useful for plugin authors, but I have no resources to document 100% of codebase, so reading the code will still be useful when writing custom plugins I'm afraid.

link

tetricky

Members 161 posts

Aug. 2, 2022, 1:20 a.m. Aug. 2, 2022, 1:20 a.m.

link

I'm hoping to get to know misago, with a long term plan to use it to replace my long standing community site.

I've not done any coding any time recently, but I might try to write a plugin for xmpp notifications. Quite reasonably I don't expect that to be part of your feature set, but its something that I would like.

First I'm intending to work on a deployment scheme for podman, and then k8s.

I have other things, non-misago, that I need to work on before that.

link

rafalp

Project Lead 2029 posts

Aug. 2, 2022, 11:46 a.m. Aug. 2, 2022, 11:46 a.m.

link

I wouldn't plan around v4 too much yet ;) I'm expecting to get big features done sometime in 2023 (threads/posting/private/moderation/reporting/search/user profiles) but after that there will be small features to implement, things like account activation, password reset, avatar controls, etc. ect. This will also take a while to implement.

link

rafalp

Project Lead 2029 posts

Dec. 28, 2023, 9:59 p.m. Dec. 28, 2023, 9:59 p.m.

link

I am trying to write dev docs together with changes I am making in the codebase. Currently hose docs are available in the dev-docs directory on main repo but after I am out of the woods with higher priority work, I'll be happy to work on a proper website for Misago.