katalyst / koi

Administration tools for Rails applications
https://github.com/katalyst/koi
MIT License
9 stars 4 forks source link

Extension entry points are hard to discover #616

Open AlanCornthwaiteKatalyst opened 3 months ago

AlanCornthwaiteKatalyst commented 3 months ago

Wanting to make changes to the look and feel of koi can be tricky to understand and discover. There have been times where we've wanted to make small visual changes to Koi's interface and have made the change in the projects /assets/stylesheets/application.scss file (or equivalent) and haven't seen any changes represented in Koi. After some digging we find the file that is actually loading is the assets/stylesheets/koi/admin.scss file. This is were our change should go.

The same thing has occurred when wanting to add new javascript libraries to a admin module. Koi doesn't provide easily identifiable extension entry points for common use cases. In this case our options were to add a script tag to the head content_for block or overload the layouts/koi/application file and change the javascrtip_import_tag location is something that loads the koi/admin file plus our changes.

Perhaps it could be a documentation improvement but a suggestion i have is that we eject these extension points during the installation process of koi/