Skip to content

Document extra_applications requirement for external modules #461

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ddon merged 1 commit into from
Mar 30, 2026
Merged

Document extra_applications requirement for external modules #461

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,18 @@ Built-in Dashboard Features

## Guidelines

### External Module Auto-Discovery

When extracting modules to standalone packages, the package's `mix.exs` **must** include `:phoenix_kit` in `extra_applications`:

```elixir
def application do
[extra_applications: [:logger, :phoenix_kit]]
end
```

Without this, `PhoenixKit.ModuleDiscovery` won't find the module and routes will return 404. See `phoenix_kit_hello_world` for the template.

### PhoenixKit Layout Guidelines

PhoenixKit uses its own layout wrapper component instead of the standard Phoenix `Layouts.app`:
Expand Down
Loading