docs: don't show readme on ash_hq (#160)

* docs: don't show readme on ash_hq

* docs: show phoenix 1.7 compatibility note and add ash_apis config
This commit is contained in:
Zach Daniel 2023-01-25 17:51:03 -05:00 committed by GitHub
parent 646dedcff6
commit 6486858511
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 1 deletions

View file

@ -106,6 +106,13 @@ defmodule MyApp.Accounts do
end
```
Be sure to add it to the `ash_apis` config in your `config.exs`
```elixir
# in config/config.exs
config :my_app, :ash_apis, [..., MyApp.Accounts]
```
Next, let's define our registry:
```elixir

View file

@ -39,6 +39,11 @@ Add `ash_authentication_phoenix` to your `.formatter.exs`:
]
```
## Phoenix 1.7 compatibility
In `your_app_web.ex` you will need to change `helpers: false` to `helpers: true` in the router section. AshAuthenticationPhoenix relies on
these helpers to know where your authenticated routes are.
## `AshAuthentication.Phoenix.Router`
`ash_authentication_phoenix` includes several helper macros which can generate

View file

@ -83,7 +83,7 @@ defmodule AshAuthentication.MixProject do
Path.wildcard("documentation/**/*.md"))
|> Enum.map(fn
"README.md" ->
{:"README.md", title: "Read Me"}
{:"README.md", title: "Read Me", ash_hq?: false}
"documentation/tutorials/" <> _ = path ->
{String.to_atom(path), []}