More documentation/resources for using the Tabbycat API

[teymour-aldridge]

Tabbycat has a pretty good API (although I find all the subclassing in the implementation a little tricky to wrap my head around), and it's a shame that there aren't more user-defined extensions. I think one thing that could help here is to improve the documentation and make the existence of the API more prominent.

I think it would make sense to add an API/"writing extensions" page to https://tabbycat.readthedocs.io pointing to the existing Redoc documentation, as well as tidying up that documentation (e.g. removing internal implementation-specific details from the API docs, more/improved examples).

Perhaps unsurprisingly (given that I am opening this issue) I would be happy to work on this!

[tienne-B]

What do you mean by user-defined extensions? Something like an "add-on library" within Tabbycat?

Also, other than the action log text fixed in 940f173, what do you mean by "internal implementation-specific details"?

[teymour-aldridge]

What do you mean by user-defined extensions? Something like an "add-on library" within Tabbycat?

I guess general applications written to interface with the API, although I realised there is a doc page for the API. I think a few more examples on how to use it would be good.

Also, other than the action log text fixed in 940f173, what do you mean by "internal implementation-specific details"?

That was it!