Be part of JetBrains PHPverse 2026 on June 9 – a free online event bringing PHP devs worldwide together.

casc-or's avatar

End User Documentation

I have a moderately sized Laravel application which is somewhat intuitive but needs end user documentation ("help"). The user base is about 200 people ranging in age from 18 to 80+ so I am dealing with a wide range of users.

I would like to embed that documentation in the app itself so the docs can be updated with the code.

I have experimented with the package binarytorch/larecipe - great package but am finding it somewhat limiting. I have four or five user roles and I haven't figured out how I can do hierarchical documentation with multiple levels for the roles and an index for each level for one thing.

Anyone here have any suggestions for other things I might look at?

I'd really like to get my help inside my app.blade.php so it looks like the rest of the app which I think means I need the help pages themselves to be blade too.

Any suggestions appreciated.

0 likes
3 replies
casc-or's avatar

@MohamedTammam Thanks - I'm not so much interested in using Markdown, I'd be comfortable creating blade files for the actual pages, as I am in rendering the output as if it were part of the site.

Since posting I've started to experiment in resources/views/vendor/larecipe doing some customizations on the blade there and maybe that's the way to get to what I want.

MohamedTammam's avatar

@casc-or My suggestion is to write markdown inside the blade file. The documentation will be part of the source code.

Please or to participate in this conversation.