improvement: update to new ash docs patterns

This commit is contained in:
Zach Daniel 2023-01-18 01:02:01 -05:00
parent 351f46e5af
commit f5e338cd9d
3 changed files with 8 additions and 42 deletions

View file

@ -6,10 +6,10 @@ The AshPhoenix plugin adds lots of helpers for working with Phoenix Liveview (an
## Whats in the box?
- {{link:ash_phoenix:module:AshPhoenix.Form}} - A form data structure for using resource actions with phoenix forms
- {{link:ash_phoenix:module:AshPhoenix.Form.Auto}} - Tools to automatically determine nested form structures based on calls `manage_relationship` for an action.
- {{link:ash_phoenix:module:AshPhoenix.FilterForm}} - A form data structure for building filter statements
- {{link:ash_phoenix:module:AshPhoenix.LiveView}} - Helpers for querying data and integrating changes
- {{link:ash_phoenix:module:AshPhoenix.SubdomainPlug}} - A plug to determine a tenant using subdomains for multitenancy
- {{link:ash_phoenix:module:AshPhoenix.FormData.Error}} - A protocol to allow errors to be rendered in forms
- `AshPhoenix.Form` - A form data structure for using resource actions with phoenix forms
- `AshPhoenix.Form.Auto` - Tools to automatically determine nested form structures based on calls `manage_relationship` for an action.
- `AshPhoenix.FilterForm` - A form data structure for building filter statements
- `AshPhoenix.LiveView` - Helpers for querying data and integrating changes
- `AshPhoenix.SubdomainPlug` - A plug to determine a tenant using subdomains for multitenancy
- `AshPhoenix.FormData.Error` - A protocol to allow errors to be rendered in forms
- `Phoenix.HTML.Safe` implementations for `Ash.CiString` and `Ash.NotLoaded`

View file

@ -1,35 +0,0 @@
defmodule AshPhoenix.DocIndex do
@moduledoc false
use Spark.DocIndex,
guides_from: [
"documentation/**/*.md"
]
def for_library, do: "ash_phoenix"
def extensions do
[]
end
def code_modules,
do: [
{"Phoenix Helpers",
[
AshPhoenix.Form,
AshPhoenix.Form.Auto,
AshPhoenix.FilterForm,
AshPhoenix.LiveView,
AshPhoenix.FormData.Error,
AshPhoenix.SubdomainPlug
]},
{"Errors",
[
AshPhoenix.Form.InvalidPath,
AshPhoenix.Form.NoActionConfigured,
AshPhoenix.Form.NoDataLoaded,
AshPhoenix.Form.NoFormConfigured,
AshPhoenix.Form.NoResourceConfigured
]}
]
end

View file

@ -102,7 +102,8 @@ defmodule AshPhoenix.MixProject do
AshPhoenix.Form.NoFormConfigured,
AshPhoenix.Form.NoResourceConfigured
]
]
],
Internals: ~r/.*/
]
end