Bad Documentation for Beginners #720

Closed
opened 2026-02-04 22:03:30 +03:00 by OVERLORD · 4 comments
Owner

Originally created by @CaptnBook4Git on GitHub (Jun 17, 2018).

For Feature Requests

Hey there,

the documentation is, to be honest, really bad.

I just wanted to add an simple click counter to the pages. But i can't find any possibilitys to do that.
But i am an noob with laravel, so maybe the fault is on my side.

But i would love to get some possibilitys to produce my own extensions.

Maybe anybody can help me.

Originally created by @CaptnBook4Git on GitHub (Jun 17, 2018). ### For Feature Requests Hey there, the documentation is, to be honest, really bad. I just wanted to add an simple click counter to the pages. But i can't find any possibilitys to do that. But i am an noob with laravel, so maybe the fault is on my side. But i would love to get some possibilitys to produce my own extensions. Maybe anybody can help me.
Author
Owner

@ssddanbrown commented on GitHub (Jun 17, 2018):

Hi @iBooster , Thanks for opening this issue.

Yeah, I'm aware the docs need work. That said, Providing information on a 'click counter' is quite specific and BookStack isn't really set-up for extensions at the moment, since BookStack is primarily to be a ready-to-go docs system rather than an extensible platform, which is why you cannot find documentation on this.

Further customization options have been requested and some are in the works.

Since there's nothing directly actionable on this issue I'm going to close it. If there's something specific to be improved in the documentations or a specific topic you'd like help on please open a new issue with more information on what you require.

@ssddanbrown commented on GitHub (Jun 17, 2018): Hi @iBooster , Thanks for opening this issue. Yeah, I'm aware the docs need work. That said, Providing information on a 'click counter' is quite specific and BookStack isn't really set-up for `extensions` at the moment, since BookStack is primarily to be a ready-to-go docs system rather than an extensible platform, which is why you cannot find documentation on this. Further customization options have been requested and some are in the works. Since there's nothing directly actionable on this issue I'm going to close it. If there's something specific to be improved in the documentations or a specific topic you'd like help on please open a new issue with more information on what you require.
Author
Owner

@CaptnBook4Git commented on GitHub (Jun 17, 2018):

Okay, i fully understand that. But i need to customize it anyway. So would it be possible to get a little text where i can find „hooks“.

Is the project structure a result of laravel? Maybe this can help me to finde those hooks by myself

@CaptnBook4Git commented on GitHub (Jun 17, 2018): Okay, i fully understand that. But i need to customize it anyway. So would it be possible to get a little text where i can find „hooks“. Is the project structure a result of laravel? Maybe this can help me to finde those hooks by myself
Author
Owner

@ssddanbrown commented on GitHub (Jun 18, 2018):

@iBooster Yes, The project structure generally follows Laravel's defaults. Be aware that any customization at this level though has the potential to cause update issues going forward.

@ssddanbrown commented on GitHub (Jun 18, 2018): @iBooster Yes, The project structure generally follows Laravel's defaults. Be aware that any customization at this level though has the potential to cause update issues going forward.
Author
Owner

@CaptnBook4Git commented on GitHub (Jun 18, 2018):

The possibility of extensions would minimize this potential

@CaptnBook4Git commented on GitHub (Jun 18, 2018): The possibility of extensions would minimize this potential
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/BookStack#720