Skip to content

API: Add documentation about the existing comic API

Jookia requested to merge RFC_episodes-api into master

Signed-off-by: Jookia 166291@gmail.com

This commit documents the existing API as created and used by @Deevad , @calimeroteknik and @imsesaok .

There's a lot of criticism for this commit around its language, but I don't think its a blocker. Everybody I've talked to so far indicates this documentation is correct. At the very least it's 'good enough' which means there's consensus there's no major blockers. Future work centers around using better language in some places but that's about it.

The only inaccuracy I can think of is that episode names may include more than alphanumerics and dashes, though I haven't seen this. I think it's a good idea to provide some limit of what can be in an episode directory name since it makes it easier for scripts to handle.

Merge request reports