Flarum API Documentation (PHP & JS)

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.

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... 🤣

« Previous Page