Better documentation

[binyaminyblatt]

I would love to help the community maintain extensions but I have no time to dissect this entire package and figure out how it works if there was better documentation I feel that we would be able to attract more maintainers for extensions and thereby make the community grow better

[celarye]

+1, it would make it a lot easier for users to get into source development.

Ideally for the documentation you would want:

1. How to set up the development environment, either from scratch or by forking an/the existing example.

2. A starting guide with a copyright-free scraping example (so you can include cheerio into the guide) and another example to show how to do it with an API. This guide should explain what the functions are for, which are at least needed for the source to be functional and how these functions exactly work (, etc.?). This would be a perfect starting point which the community can build onto.

3. How to deploy the source after the development process is done.

[binyaminyblatt]

I think a good example to use might be mangadex because it's got an open API and they encourage people to make clients for it

[celarye]

This unfortunately won’t be possible because of it supporting unlicensed content.

[binyaminyblatt]

What about one of the self-hosted platforms those for sure are not your problem and they all have documented apis

For instance Kavita https://github.com/Kareadita/Kavita
As far as I can tell it's an OPDS which should make it pretty easy to use already made extensions to better document things because basically it would be rewriting the komanga extension as well as having a public demo which can be used for testing purposes
It also has a takiyomi extension which can be used as a template

[therobbiedavis]

What about one of the self-hosted platforms those for sure are not your problem and they all have documented apis

For instance Kavita https://github.com/Kareadita/Kavita As far as I can tell it's an OPDS which should make it pretty easy to use already made extensions to better document things because basically it would be rewriting the komanga extension as well as having a public demo which can be used for testing purposes It also has a takiyomi extension which can be used as a template

A user already made a paperback extension for Kavita.
https://github.com/ACK72/kavya-paperback
https://github.com/ACK72/kavya-paperback-tracker

[binyaminyblatt]

I was using it as an example

[pitriq]

I second this issue's request, and would also love to see an example on how to test Sources. Most extensions I've seen lack tests, and the ones which have them are using outdated methods (example).

[Ivanmatthew]

+1, a third party could offer making the generation of and documentation so paper doesn’t get in trouble with apple