chore: add docs

documentation/dsls/DSL:-AshPaperTrail.Api.md

@@ -0,0 +1,12 @@
+<!--
+This file was generated by Spark. Do not edit it by hand.
+-->
+# DSL: AshPaperTrail.Api
+
+Documentation for `AshPaperTrail.Api`.
+
+
+
+
+
+<style type="text/css">.spark-required::after { content: "*"; color: red !important; }</style>

documentation/dsls/DSL:-AshPaperTrail.Registry.md

@@ -0,0 +1,11 @@
+<!--
+This file was generated by Spark. Do not edit it by hand.
+-->
+# DSL: AshPaperTrail.Registry
+
+Deprecated in favor of `AshPaperTrail.Api`. Extends a registry to include the versions of paper trail resources. 
+
+
+
+
+<style type="text/css">.spark-required::after { content: "*"; color: red !important; }</style>

documentation/dsls/DSL:-AshPaperTrail.Resource.md

@@ -0,0 +1,89 @@
+<!--
+This file was generated by Spark. Do not edit it by hand.
+-->
+# DSL: AshPaperTrail.Resource
+
+Documentation for `AshPaperTrail.Resource`.
+
+
+## paper_trail
+A section for configuring how versioning is derived for the resource.
+
+
+### Nested DSLs
+ * [belongs_to_actor](#paper_trail-belongs_to_actor)
+
+
+
+
+
+### Options
+
+| Name | Type | Default | Docs |
+|------|------|---------|------|
+| [`attributes_as_attributes`](#paper_trail-attributes_as_attributes){: #paper_trail-attributes_as_attributes } | `list(atom)` | `[]` | A set of attributes that should be set as attributes on the version resource, instead of stored in the freeform `changes` map attribute. |
+| [`change_tracking_mode`](#paper_trail-change_tracking_mode){: #paper_trail-change_tracking_mode } | `:snapshot \| :changes_only \| :full_diff` | `:snapshot` | Changes are stored in a map attribute called `changes`.  The `change_tracking_mode`  determines what's stored. Valid options are `:snapshot` and `:changes_only` and `:full_diff`. :snapshot will json dump the contents of every attribute whether they changed or not. `{ subject: "new subject", body: "unchanged body", author: { name: "bob"}}` :changes_only will json dump the contents of only the attributes that have changed.  Note if any part of an embedded attribute and array of embedded attributes, changes then the entire top level attribute is dumped. `{ subject: "new subject" }` :full_diff will json dump the contents of each attribute. `{ subject: { from: "subject", to: "new subject" }, body: { unchanged: "unchanged_body" }}, author: { changes: { unchanged: "bob" }}` |
+| [`ignore_attributes`](#paper_trail-ignore_attributes){: #paper_trail-ignore_attributes } | `list(atom)` | `[]` | A list of attributes that should be ignored. Typically you'll want to ignore your timestamps. The primary key is always ignored. |
+| [`mixin`](#paper_trail-mixin){: #paper_trail-mixin } | `atom` |  | A module that defines a `using` macro that will be mixed into the version resource. |
+| [`on_actions`](#paper_trail-on_actions){: #paper_trail-on_actions } | `list(atom)` |  | Which actions should produce new versions. By default, all create/update actions will produce new versions. |
+| [`reference_source?`](#paper_trail-reference_source?){: #paper_trail-reference_source? } | `boolean` | `true` | Whether or not to create a foreign key reference from the version to the source. This should be set to `false` if you are allowing actual deletion of data. Pair this extension with `AshArchival` to get soft destroys and referential integrity. Only relevant for resources using the AshPostgres data layer. |
+| [`store_action_name?`](#paper_trail-store_action_name?){: #paper_trail-store_action_name? } | `boolean` | `false` | Whether or not to add the `version_action_name` attribute to the  version resource. This is useful for auditing purposes. The `version_action_type` attribute is always stored. |
+| [`version_extensions`](#paper_trail-version_extensions){: #paper_trail-version_extensions } | `keyword` | `[]` | Extensions that should be used by the version resource. For example: `extensions: [AshGraphql.Resource], notifier: [Ash.Notifiers.PubSub]` |
+
+
+
+## paper_trail.belongs_to_actor
+```elixir
+belongs_to_actor name, destination
+```
+
+
+Creates a belongs_to relationship for the actor resource. When creating a new version, if the actor on the action is set and 
+matches the resource type, the version will be related to the actor. If your actors are polymorphic or varying types, declare a 
+belongs_to_actor for each type.
+
+A reference is also created with `on_delete: :nilify` and `on_update: :update`
+
+If you need more complex relationships, set `define_attribute? false` and add the relationship via a mixin.
+
+If your actor is not a resource, add a mixin and with a change for all creates that sets the actor's to one your attributes. 
+The actor on the version changeset is set.
+
+
+
+
+### Examples
+```
+belongs_to_actor :user, MyApp.Users.User, api: MyApp.Users
+```
+
+
+
+### Arguments
+
+| Name | Type | Default | Docs |
+|------|------|---------|------|
+| [`name`](#paper_trail-belongs_to_actor-name){: #paper_trail-belongs_to_actor-name .spark-required} | `atom` |  | The name of the relationship to use for the actor (e.g. :user) |
+| [`destination`](#paper_trail-belongs_to_actor-destination){: #paper_trail-belongs_to_actor-destination } | `module` |  | The resource of the actor (e.g. MyApp.Users.User) |
+### Options
+
+| Name | Type | Default | Docs |
+|------|------|---------|------|
+| [`allow_nil?`](#paper_trail-belongs_to_actor-allow_nil?){: #paper_trail-belongs_to_actor-allow_nil? } | `boolean` | `true` | Whether this relationship must always be present, e.g: must be included on creation, and never removed (it may be modified). The generated attribute will not allow nil values. |
+| [`api`](#paper_trail-belongs_to_actor-api){: #paper_trail-belongs_to_actor-api } | `atom` |  | The API module to use when working with the related entity. |
+| [`attribute_type`](#paper_trail-belongs_to_actor-attribute_type){: #paper_trail-belongs_to_actor-attribute_type } | `any` | `:uuid` | The type of the generated created attribute. See `Ash.Type` for more. |
+| [`define_attribute?`](#paper_trail-belongs_to_actor-define_attribute?){: #paper_trail-belongs_to_actor-define_attribute? } | `boolean` | `true` | If set to `false` an attribute is not created on the resource for this relationship, and one must be manually added in `attributes`, invalidating many other options. |
+
+
+
+
+
+### Introspection
+
+Target: `AshPaperTrail.Resource.BelongsToActor`
+
+
+
+
+
+<style type="text/css">.spark-required::after { content: "*"; color: red !important; }</style>