mirror of
https://github.com/ash-project/ash.git
synced 2024-09-20 05:23:03 +12:00
chore: update docs
This commit is contained in:
parent
b7fb69e688
commit
82878e346c
2 changed files with 6 additions and 2 deletions
|
@ -42,7 +42,7 @@ end
|
|||
|
||||
## Create a resource
|
||||
|
||||
A resource is the primary entity in Ash. Your Api module ties your resources together and gives them an interface, but the vast majority if your configuration will live in a resource. In your typical setup, you might have a resource per database table. For those already familiar with ecto, a resource and an ecto schema are very similar. In fact, all resources define an ecto schema under the hood. This can be leveraged when you need to do things that are not yet implemented or fall outside of the scope of Ash. The current reccomendation for where to put your resources is in `lib/<resource_name>.ex`. Here are a few examples:
|
||||
A resource is the primary entity in Ash. Your Api module ties your resources together and gives them an interface, but the vast majority if your configuration will live in a resource. In your typical setup, you might have a resource per database table. For those already familiar with ecto, a resource and an ecto schema are very similar. In fact, all resources define an ecto schema under the hood. This can be leveraged when you need to do things that are not yet implemented or fall outside of the scope of Ash. The current reccomendation for where to put your resources is in `lib/resources/<resource_name>.ex`. Here are a few examples:
|
||||
|
||||
```elixir
|
||||
# in lib/resources/tweet.ex
|
6
mix.exs
6
mix.exs
|
@ -38,7 +38,11 @@ defmodule Ash.MixProject do
|
|||
main: "Ash",
|
||||
source_ref: "v#{@version}",
|
||||
logo: "logos/small-logo.png",
|
||||
extras: ["documentation/getting_started.md"],
|
||||
extra_section: "GUIDES",
|
||||
extras: ["documentation/introduction/getting_started.md"],
|
||||
groups_for_extras: [
|
||||
Introduction: Path.wildcard("documentation/introduction/*.md")
|
||||
],
|
||||
groups_for_modules: [
|
||||
entrypoint: [
|
||||
Ash,
|
||||
|
|
Loading…
Reference in a new issue