User manual

MartinR

One of the fora I follow started using Flarum a few months ago. After struggling yet again to add an image I ended up asking what software was used. So the first suggestion is:
At least the name, if not a link, to Flaurm aught to be at the bottom of displayed pages
There seems to be no user level documentation. After much pestering other members of the forum it appears that "Add an image" does not add the image, but merely link to it. Other fora I use allow images to be embedded so there is no need to move the image out onto the internet somewhere. Next suggestion:
Change "Add an image" to be "Link to an image"
The final suggestion is to provide a user manual. Not one for forum administrators, but for forum users. Flarum has a nice look but it is a pity when you can waste an hour or two trying to do something that SMF (as just one example) allows you to do in seconds. The manual could also usefully cover items like how to add tags, what tags are available and also what are the flags. I love experimenting on my own system, but am loath to do so on a public forum where it can affect and annoy other readers. Oh and one final point, is it possible to add a preview to the first posting? Thanks, Martin

clarkwinkelmann

Thanks for the feedback.

There are a few existing discussions about the possible ways to document formatting. One of which is https://discuss.flarum.org/d/25365-formatting-quick-reference-guide Flarum composer is designed to be simple to use for basic text, and relies on common formatting formats Markdown and BBcode. We don't include a link back to Flarum out of the box, but the forum administrator could include links to Flarum or Markdown/bbcode at their own convenience.

Image upload can be added with community extensions. Flarum does not ship with that feature out of the box.

We have a (partial) user documentation for the admin features at https://docs.flarum.org/admin.html We plan to expand and improve the documentation once Flarum reaches stable.

We have an issue for the missing new discussion preview. It's planned to tackle it after Flarum stable flarum/core861

MartinR

Thanks for getting back to me. I'll follow up the quick ref guide in the morning (it's 23:53 here). I'll get back to the forum administrator over the link back. It's not the admin features, just the simple user features, but then again I'll read the QR discussion first.