expand the documentation

[MDHtrappy]

as a student developer, the five pages of documentation are not enough to understand some of its features :)

[Vexcited]

Yes ! You're absolutely right and actually the reason why the documentation is so small, is because the API isn't stable enough...

I'd love to start writing a bit of the documentation but the thing is that I move a lot of stuff when implementing new features and that means a lot of breaking changes and if the docs are not updated in consequences, it might just result in a big outdated mess.

For now, I'd recommend you to play around with the examples given in the /examples folder. That's what I use to perform my tests while implementing new features so if you understand enough TS or JS, you can get started using those.

Sadly, there's not a lot of comments on the methods or properties in the code so even IntelliSense might not give you more insights on what does what so this is probably something I should also improve in the future.

[Vexcited]

Moved the issue since the documentation is now hosted at docs.literate.ink/pawnote

Here's a few guides that needs to be written to have something a bit usable :

• Authentication
• Timetable
• Grades
• Homework
• Attendance