[Feature Request] api documentation

[helleputter]

Problem

As mentioned in the readme.md there is no api documentation.

The link on the word api on the readme goes to a 404 page and the links reference the 1.17.x branch.

There are however comments in the files in the api folder.

Feature

As mentioned in #42 the development of this mod is an unpaid hobby of yours.
I want to help if this is permitted.
I am just unsure if only the readme.md links need to be updated or there still needs to be a markdown/wiki for the api and what you prefer.

Other Solutions

No response

Additional Information

No response

[Kir-Antipov]

Whoops, I guess I accidentally Ctrl+Shift+H'd myself. I vaguely remember that some links were pointing to the dev branch, but then I decided to replace them with links to the stable one. The problem, however, lies in the fact that there's dev in the file paths too, and they got modified as well.

Thank you for your consideration. It's always a heartwarming experience when somebody offers help, and, of course, the help is always welcome :)

I've always wanted to provide an expressive wiki so people don't need to go through comments and examples to understand how the stuff I wrote works. However, it's a very time-consuming task, and I'm currently overbooked with other projects, so I don't see myself working on it anytime soon. (It doesn't mean I won't update the mod itself, though)