Tiny Tiny RSS: Community

Review: HOOKS Documentation


#1

@fox @JustAMacUser

I’ve been trying to make sure I understand all of the plugin hooks before I dive in fully. I’ve created this:
Hooks Documentation (HOOKS.md) in a branch.

If you’d like to review before I do a PR let me know. Once it’s in, it would also be good to point there for hooks documentation vs the file in the source tree.

Thanks.


#2

i think source should be good enough explanation for the hooks + i don’t really want to proof-read this to check whether your understanding is correct and, more importantly, the burden of maintaining this document in the future (hooks, after all, might be added or changed in the future)

it’s very nice that you went through all this effort but i think it would be better if this is kept and maintained separately, outside of trunk


#3

Understood. I’ve made a GIST here with a disclaimer about keeping it updated: https://gist.github.com/Fmstrat/a5adc35633725d9369b50d8524b450ca

If you would like, feel free to link from https://git.tt-rss.org/fox/tt-rss/wiki/Plugins