chore: update docs

This commit is contained in:
Zach Daniel 2020-07-09 09:25:48 -04:00
parent b7fb69e688
commit 82878e346c
No known key found for this signature in database
GPG key ID: C377365383138D4B
2 changed files with 6 additions and 2 deletions

View file

@ -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

View file

@ -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,