Development

This page is intended for contributors/maintainers working on the engine itself.

Setup

From the gem root:

bundle install

Run tests

bundle exec rake test

Dummy app

AdminSuite uses a Rails “dummy” app under test/dummy for integration tests and to exercise routing/assets in a host-like environment.

Useful commands (from the gem root):

cd test/dummy
bin/rails s

Assets / Tailwind

AdminSuite ships:

• app/assets/admin_suite.css (baseline CSS)
• app/assets/tailwind/admin_suite.css (Tailwind input)

The engine Tailwind build task writes the compiled CSS into the host app builds folder:

• Output: Rails.root/app/assets/builds/admin_suite_tailwind.css

In a host app, this is run automatically during assets:precompile:

bin/rails admin_suite:tailwind:build

When developing inside the engine repo itself, you can run it from the dummy app:

cd test/dummy
bin/rails admin_suite:tailwind:build

Documentation

The public documentation uses Jekyll and Just the Docs with dark mode, navigation, and full-text search. See Publishing the docs for editing, export, preview, validation, and deployment commands.

Editable product documentation lives in the TechWright vault at _vault/products/admin_suite/docs/. The repository contains a generated publication snapshot under site/generated/, not another authoring directory. The engine’s built-in viewer reads a host-configured directory independently of the public documentation site; see Docs viewer.