Skip to content

Commit

Permalink
docs: show mix tasks in docs and update task description
Browse files Browse the repository at this point in the history
  • Loading branch information
zachdaniel committed Dec 17, 2024
1 parent a3c21c0 commit bcd5b15
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
7 changes: 2 additions & 5 deletions documentation/tutorials/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ add authentication to your resources and APIs.
#### Install the extension

```sh
mix igniter.install ash_authentication
mix igniter.install ash_authentication --auth-strategy magic_link,password
```

##### Using Phoenix?
Expand All @@ -21,12 +21,9 @@ Use the following. If you have not yet run the above command, this will prompt y
so you can run both or only this one.

```sh
mix igniter.install ash_authentication_phoenix
mix igniter.install ash_authentication_phoenix --auth-strategy magic_link,password
```

There is not a task(yet) for configuring the strategies and add-ons that you use.
So continue on below and select your strategies/add-ons and set them up manually.

### Manual

#### Add to your application's dependencies
Expand Down
5 changes: 4 additions & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,10 @@ defmodule AshAuthentication.MixProject do
"""
end
end,
filter_modules: ~r/^Elixir.AshAuthentication/,
filter_modules: fn mod, _ ->
String.starts_with?(inspect(mod), "AshAuthentication") ||
String.starts_with?(inspect(mod), "Mix.Task")
end,
source_url_pattern:
"https://github.com/team-alembic/ash_authentication/blob/main/%{path}#L%{line}",
groups_for_modules: [
Expand Down

0 comments on commit bcd5b15

Please sign in to comment.