admin_suite 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.gitignore +1 -0
- data/CHANGELOG.md +17 -0
- data/README.md +137 -1
- data/docs/README.md +26 -0
- data/docs/actions.md +98 -0
- data/docs/configuration.md +198 -0
- data/docs/development.md +64 -0
- data/docs/docs_viewer.md +79 -0
- data/docs/fields.md +188 -0
- data/docs/installation.md +80 -0
- data/docs/portals.md +98 -0
- data/docs/releasing.md +38 -0
- data/docs/resources.md +237 -0
- data/docs/theming.md +63 -0
- data/docs/troubleshooting.md +50 -0
- data/lib/admin_suite/version.rb +1 -1
- data/test/dummy/log/test.log +109 -403
- data/test/dummy/tmp/local_secret.txt +1 -1
- metadata +18 -3
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# Troubleshooting
|
|
2
|
+
|
|
3
|
+
## “My resources don’t show up in the sidebar”
|
|
4
|
+
|
|
5
|
+
Checklist:
|
|
6
|
+
|
|
7
|
+
- Your resource class:
|
|
8
|
+
- is under `Admin::Resources`
|
|
9
|
+
- ends with `Resource` (e.g. `UserResource`)
|
|
10
|
+
- sets both `portal :...` and `section :...`
|
|
11
|
+
- The file is located under one of the configured `resource_globs` paths (see [Configuration](configuration.md)).
|
|
12
|
+
|
|
13
|
+
In development, AdminSuite loads resources on-demand when building navigation. In non-development environments, you should ensure your resource files are loaded at boot (using the globs) and are not excluded by your deployment setup.
|
|
14
|
+
|
|
15
|
+
## “Constant not found” / Zeitwerk errors for host DSL files
|
|
16
|
+
|
|
17
|
+
If you store AdminSuite DSL files under `app/admin_suite/**` in the host app, those files are not constant definitions.
|
|
18
|
+
|
|
19
|
+
AdminSuite ignores `Rails.root/app/admin_suite` in Zeitwerk to prevent eager-load errors. If you still see issues:
|
|
20
|
+
|
|
21
|
+
- Ensure the DSL folder really is `app/admin_suite` (not a different path)
|
|
22
|
+
- Prefer `config/admin_suite/resources/*.rb` and `config/admin_suite/portals/*.rb` for DSL files
|
|
23
|
+
|
|
24
|
+
## “Docs viewer shows no files”
|
|
25
|
+
|
|
26
|
+
- Confirm `AdminSuite.config.docs_path` exists
|
|
27
|
+
- Ensure files are `*.md`
|
|
28
|
+
- Visit `/docs` relative to your mount path (e.g. `/internal/admin/docs`)
|
|
29
|
+
|
|
30
|
+
## “Tailwind styles are missing in production”
|
|
31
|
+
|
|
32
|
+
AdminSuite expects `assets:precompile` to run and generate:
|
|
33
|
+
|
|
34
|
+
- `app/assets/builds/admin_suite_tailwind.css` in your host app
|
|
35
|
+
|
|
36
|
+
If you don’t run precompile in your deployment pipeline, you can:
|
|
37
|
+
|
|
38
|
+
- Start running `assets:precompile`, or
|
|
39
|
+
- Build the file manually by running:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
bin/rails admin_suite:tailwind:build
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## “Icons don’t render”
|
|
46
|
+
|
|
47
|
+
AdminSuite defaults to `lucide-rails`.
|
|
48
|
+
|
|
49
|
+
If your host app excludes it, set `AdminSuite.config.icon_renderer` to provide icons (see [Theming & assets](theming.md)).
|
|
50
|
+
|