Below are a couple of known issues. Will try to knock these issues out one at a time but other developers are encouraged to fork the QuickieDox repo and attempt to help fix them. Please don't report these issues on GitHub since they are known :).
For now the navigation items have been designed to be stacked underneath a parent item. This makes it impossible to just have top level navigation items that can be clicked on. For example, in the QuickieDox navigation on the left, it would have been great to have an Overview link above Getting Started.
The current implementation of the site-wide search feature can be improved to return results much faster.
We believe a lot of people who have documentation needs would love to have a way to integrate with Algolia. This will provide a good solution to the faster search problem mentioned above. This is quite some work and hopefully will be built into future versions.
We believe some documentations require users to be logged in first before accessing them. Placeholders have been provided for this but not implemented fully. Since this is a vanilla PHP project and we believe people authenticate their users differently, it is hard to land on a one size fits all solution. You are therefore advised to implement your own authentication in Controllers/AuthController.php and Core/Auth.php. This page highlights what is already included with QuickieDox.
To get your documentation website looking different, QuickieDox has provided some guidelines here. To get your site looking really different, you will need to do quite some styling. It will be great to ship with a couple of themes users can pick from when building their documentation sites. An alternative will also be able to make it possible for 3rd parties to create themes for QuickieDox.
Currently QuickieDox requires every documentation version to be a separate branch. It should be possible to pull in documentation from tags as well.
In This Document
