Flarum API Documentation (PHP & JS)

datitisev

Flarum API Documentation

I've created Flarum's PHP and JS API (not REST API) documentation using Doctum and TypeDoc.

You can access the documentation for both the JS and PHP @ https://api.docs.flarum.org.

JS:

latest
master, v1.0.0, v1.1.0,

PHP:

latest
master, v1.0.0, v1.1.0,

You can find the source @ https://github.com/Flarum/api-docs.

datitisev

UPDATE

Added JavaScript Documentation.

BlackSheep

https://datitisev.github.io/FlarumAPIDocs/php/, 404.

datitisev

BlackSheep Thanks, let me fix that. Sorry about that.

EDIT Added index.html to that directory, changed link to https://datitisev.github.io/FlarumAPIDocs/php/index.html in README.

datitisev

UPDATE

Added JavaScript documentation for every branch and tag.
Added list for JavaScript including branches and versions, /js
Added better styling to version and branch list, and also to PHP & JS documentation selection, /
Removed JavaScript source files from ESDoc, each branch/version would have ~200MB of source files ?

datitisev

UPDATE

Changed the PHP documentation's theme to be cleaner and more Flarum-y, if you now what I mean ?

I used an existing theme, https://github.com/nochso/sami-theme, and customized it. I didn't push the theme to the Github repo, if someone wants to contribute to it and make it better, I'll include it. ?

jordanjay29

Just got to use this today. I feel like the font style/size is too thin and small within the php class lists (for example). But I find no other flaws with it.

datitisev

jordanjay29 Sorry about the late response. I forgot about you message, however I did slightly increase the font size 28 days ago in commit 04192fa

tankerkiller125

The PHP Docs still seems to be weird... Notably, the Http section is missing quite a bit? Like there's a Flarum/Http/WebApp namespace and it's not shown at all. And the Core namespace just goes to some Core class that doesn't even seem to exist?

datitisev

tankerkiller125 The WebApp is shown in the master documentation, but you are right. There are many weirdos bugs with Sami's versions (using branches and tags) and its actual doc content. I'll see if I can make a weird script so I change the branch/tag, and all Sami does is parse and render... ?

datitisev

UPDATE

Created custom script for PHP documentation as well
Most bugs with Sami having wrong version and missing classes should be resolved

There was some trouble when I accidentally created documentation for JS instead of PHP from beta.2 to beta.6. This is the status of that commit with my error:

? Everything should be resolved now, though.

/cc @tankerkiller125

datitisev

It has been a long time since the latest update.

UPDATE

Added v0.1.0-beta.7 documentation
Updated master & next-back documentation
Removed next-front documentation, as Toby symlinked a file to his computer's path
Fixed file permissions

luceos

datitisev Removed next-front documentation, as Toby symlinked a file to his computer's path

Toby mentioned on discord: "next-front is dead"

Toby

datitisev I'm not seeing beta 7 docs. Also there are a lot of JS components missing in all versions. ?

Ralkage

Toby And here I thought I was going nuts. ?

datitisev

Toby https://datitisev.github.io/FlarumAPIDocs/js/v0.1.0-beta.7 & https://datitisev.github.io/FlarumAPIDocs/php/v0.1.0-beta.7?

Can you give examples of the JS components? I just let ESDoc do its thing.

jordanjay29

datitisev

Toby

datitisev There are five JS classes listed under forum/src/components. There should be dozens.

datitisev

jordanjay29 Ah, I forgot to add them to the lists. Whoops!

Toby Hm, I'll see what I can find with ESLint debugging.