Skip to content

Latest commit

 

History

History
53 lines (42 loc) · 2.13 KB

README.md

File metadata and controls

53 lines (42 loc) · 2.13 KB

RubyUI Admin — Documentation

The README covers the essentials. This folder holds the full documentation, split by topic.

Read these inside your app. The admin can serve this documentation rendered as HTML at <mount>/docs (e.g. /admin/docs). By default (config.docs_enabled = :local) it's mounted in development/test only; set config.docs_enabled = true to expose it in production too (where it runs behind the admin's auth gate). Add kramdown + kramdown-parser-gfm to the bundle of the target environment — see Configuration › In-app docs browser.

Getting started

Resources

Fields

Actions

Filters

Dashboards & cards

Authorization

Customization

Generators & rake tasks