Flarum API Documentation (PHP & JS)

datitisev · 2016-12-10T02:06:59+00:00

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.

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.

datitisev

Well, it's a few months after I promised a fix... but better later than never

Update

Fixed a big part of the JS documentation not being available
- Occurred because of React.... easy fix with yet another plugin ?

Before

After

Ralkage

datitisev Next-back was recently merged into Master, you may want to rebuild for Master ?

datitisev

Ralkage Every time I make the docs it git pulls each branch and version

datitisev

Update

Added Github links to quickly find the source code of the piece of documentation you are looking at.
- Classes/interfaces/traits list
- Namespace
- Class/interface/trait
  - property
  - method

datitisev

Update

PHP: Escaped property descriptions to fix HtmlDocument hiding more than half the documentation in a <title> tag.

datitisev

Update

JS: Fixed some files in the master branch not being generated because of ES6
- Added esdoc-ecmascript-proposal-plugin to solve the issue

datitisev

Update

PHP
- Updated Sami (documentation generator) to v4
  - Using Sami fork @ https://github.com/blueend-ag/Sami
  - Now more classes are parsed successfully
- Applied most of the previous theme's changes to the default theme
- There were some issues because Twig or something had been updated, so everything broke, and I had no clue how to fix it
- Switched to webpack for asset management

Note: These changes only apply to the master version of the PHP documentation.

The theme will look a bit different. I tried to make it as close as possible without spending 5 hours on it... which I did ?.

datitisev

Update

PHP
- Removed al FA 5 assets and created custom font with Fontello
  - Contains 3 FA 5 icons
  - Reduces file sizes of CSS & number of HTTP requests
- Made navigation more responsive for smaller screens
- Customized scrollbars
  - Only works in Webkit-supported browsers (i.e. Chrome, Safari)
- Removed Bootstrap JS
- General improvements

These are general improvements for the changes made yesterday. As before, these changes only affect the PHP master documentation.

datitisev

Update

Added Flarum v0.1.0-beta.8 documentation

datitisev

Update

Moved documentation from api.flarum.redevs.org to https://api.flarum.dev, thanks @clarkwinkelmann
Did a thing, master documentation should automatically be updated ~~when commits are pushed to flarum/core~~ every day

datitisev

Update

It's been a while since the last update. A lot has happened that apparently never made it into a post, so I'll try to summarize as best I can.

General
- Switched domain to https://api.docs.flarum.org
- Switched CI to GitHub Actions
  - Runs every hour
  - Should automatically create sections for new major & breaking versions (e.g. 2.0.0, 1.2.0)
- Deleted all beta documentation
PHP
- Use Sami fork Doctum
JS
- Switched from ESDoc to TypeDoc (flarum/api-docs26)
  - Currently only visible in master @ https://api.docs.flarum.org/js/master/
  - Should resolve issues with some files not being visible in the API documentation
  - Actually links to the GitHub source now

davwheat

datitisev Use Sami fork

I was so confused... 🤣

askvortsov

davwheat @SychO personally writes out our PHP API docs in HTML form every release 😁

davwheat

askvortsov let's fork Sami again, so we can increase core dev numbers

Darkle

davwheat Gotta Fork 'Em All! 😂

SychO

davwheat pls no xD

datitisev

Hello all! I took time to make some much needed updates to the API documentation generation. It is now being updated automatically again, with builds for 1.x and 2.x in both JS and PHP. Additionally, instead of only producing docs for starting major tags (eg. v1.7.0, v1.8.0), it'll now produce them for the latest minor version (eg. v1.7.1 and v1.8.14 respectively). JS docs include extensions now as well, while PHP remain with just core.

Feel free to view, for example, the documentation for 2.x at https://api.docs.flarum.org/js/2.x/ and https://api.docs.flarum.org/php/2.x !

If you need to link to a tagged version, l suggest you link to eg. /js/v1.8 instead of /js/v1.8.14 so that it redirects to the proper location if new versions are published!

« Previous Page