From 63557ca3ec5b4b409ad2a978766e5f83843f8019 Mon Sep 17 00:00:00 2001 From: Adrian Marin Date: Sat, 27 Jul 2024 01:14:04 +0300 Subject: [PATCH] fix: bad hydration because of markdown extensions- convert to + - -:::option `turbo` + -:::option `download` + -:::option `keep_modal_open` + ## Customization diff --git a/docs/2.0/associations/belongs_to.md b/docs/2.0/associations/belongs_to.md index 5b2b85ed..7a361556 100644 --- a/docs/2.0/associations/belongs_to.md +++ b/docs/2.0/associations/belongs_to.md @@ -16,15 +16,15 @@ You will see three field types when you add a `BelongsTo` association to a model -:::option `allow_via_detaching` + -:::option `polymorphic_as` + -:::option `types` + -:::option `polymorphic_help` + diff --git a/docs/2.0/authorization.md b/docs/2.0/authorization.md index 19896a17..c86b1a0f 100644 --- a/docs/2.0/authorization.md +++ b/docs/2.0/authorization.md @@ -54,37 +54,37 @@ These methods control whether the resource appears on the sidebar, if the view/e -:::option `show?` + -:::option `create?` + -:::option `new?` + -:::option `edit?` + -:::option `update?` + -::::option `destroy?` + -:::option `act_on?` + Actions button -:::option `reorder?` + ## Associations When using associations, you would like to set policies for `creating` new records on the association, allowing to `attach`, `detach`, `create` or `destroy` relevant records. Again, Avo makes this easy using a straightforward naming schema. @@ -126,26 +126,26 @@ We'll have this example of a `Post` resource with many `Comment`s through the `h In the `Post` `has_many` `Comments` example, when you want to authorize `show_comments?` in `PostPolicy` you will have a `Comment` instance as the `record` variable, but when you try to authorize the `attach_comments?`, you won't have that `Comment` instance because you want to create one, but we expose the parent `Post` instance so you have more information about that authorization action that you're trying to make. ::: -:::option `attach_{association}?` + + + + + + + + + ## Removing duplication @@ -301,17 +301,17 @@ Both the `record` and the `user` will be available for you to access. -:::option `upload_{FIELD_ID}?` + -:::option `download_{FIELD_ID}?` + -:::option `delete_{FIELD_ID}?` + :::info AUTHORIZE IN BULK If you want to allow or disallow these methods in bulk you can use a little meta-programming to assign all the same value. @@ -327,32 +327,32 @@ end ``` ::: -::::option `upload_attachments?` + -::::option `download_attachments?` + -::::option `delete_attachments?` + ## Scopes @@ -468,7 +468,7 @@ end Each authorization client must expose a few methods. -:::option `authorize` + + + + ## Rolify integration diff --git a/docs/2.0/common/associations_attach_scope_option_common.md b/docs/2.0/common/associations_attach_scope_option_common.md index 923d9739..a187f79f 100644 --- a/docs/2.0/common/associations_attach_scope_option_common.md +++ b/docs/2.0/common/associations_attach_scope_option_common.md @@ -1,4 +1,4 @@ -:::option `attach_scope` + diff --git a/docs/2.0/common/associations_description_option_common.md b/docs/2.0/common/associations_description_option_common.md index 538729b0..16059ac3 100644 --- a/docs/2.0/common/associations_description_option_common.md +++ b/docs/2.0/common/associations_description_option_common.md @@ -1,4 +1,4 @@ -:::option `description` + diff --git a/docs/2.0/common/associations_discreet_pagination_option_common.md b/docs/2.0/common/associations_discreet_pagination_option_common.md index e0c37699..4b87676c 100644 --- a/docs/2.0/common/associations_discreet_pagination_option_common.md +++ b/docs/2.0/common/associations_discreet_pagination_option_common.md @@ -1,4 +1,4 @@ -:::option `discreet_pagination` + diff --git a/docs/2.0/common/associations_hide_search_input_option_common.md b/docs/2.0/common/associations_hide_search_input_option_common.md index 89ff6f8a..46abe57d 100644 --- a/docs/2.0/common/associations_hide_search_input_option_common.md +++ b/docs/2.0/common/associations_hide_search_input_option_common.md @@ -1,4 +1,4 @@ -:::option `hide_search_input` + diff --git a/docs/2.0/common/associations_link_to_child_resource_common.md b/docs/2.0/common/associations_link_to_child_resource_common.md index f3bc2165..894299ef 100644 --- a/docs/2.0/common/associations_link_to_child_resource_common.md +++ b/docs/2.0/common/associations_link_to_child_resource_common.md @@ -1,4 +1,4 @@ -:::option `link_to_child_resource` + diff --git a/docs/2.0/common/associations_scope_option_common.md b/docs/2.0/common/associations_scope_option_common.md index 3ad183bd..f5b558c3 100644 --- a/docs/2.0/common/associations_scope_option_common.md +++ b/docs/2.0/common/associations_scope_option_common.md @@ -1,4 +1,4 @@ -:::option `scope` + diff --git a/docs/2.0/common/associations_searchable_option_common.md b/docs/2.0/common/associations_searchable_option_common.md index 4e9ca6e1..4b1d4903 100644 --- a/docs/2.0/common/associations_searchable_option_common.md +++ b/docs/2.0/common/associations_searchable_option_common.md @@ -1,4 +1,4 @@ -::::option `searchable` + -:::option Number + -:::option Select + -:::option Text + + -:::option `always_expanded` + ## Field to filter matching On versions **lower** than the filters are not configurable so each field will have a dedicated filter type. Check how to do a more advanced configuration on the [custom dynamic filters](#custom-dynamic-filters) section. @@ -298,7 +298,7 @@ Each option specified below can be used as a key in the hash definition or as a :::info Filters order The filter order is computed. Dynamic filters defined by the `dynamic_filter` method will respect the definition order and will be rendered first in the filter list. Filters declared using the field's `filterable` option will be sorted by label. ::: -:::option `label` + -:::option `icon` + -:::option `type` + -:::option `query` + -:::option `conditions` + -:::option `query_attributes` + -:::option `suggestions` + diff --git a/docs/3.0/eject-views.md b/docs/3.0/eject-views.md index 54e8c342..074d7422 100644 --- a/docs/3.0/eject-views.md +++ b/docs/3.0/eject-views.md @@ -6,7 +6,7 @@ If you want to change one of Avo's built-in views, you can eject it, update it a Once ejected, the views will not receive updates on new Avo releases. You must maintain them yourself. ::: -:::option `--partial` + -:::option `--component` + -:::option `--field-components` + + + -:::option `--scope` + diff --git a/docs/3.0/encryption-service.md b/docs/3.0/encryption-service.md index b99fe920..91002802 100644 --- a/docs/3.0/encryption-service.md +++ b/docs/3.0/encryption-service.md @@ -10,25 +10,25 @@ The `EncryptionService` is an service that can be called anywhere on the app. ### Public methods -:::option `encrypt` + -:::option `decrypt` +

### Mandatory arguments: -:::option `message` + -:::option `purpose` +

diff --git a/docs/3.0/execution-context.md b/docs/3.0/execution-context.md index 93d4872e..4599264d 100644 --- a/docs/3.0/execution-context.md +++ b/docs/3.0/execution-context.md @@ -60,40 +60,40 @@ Avo::ExecutionContext.new(target: &SOME_BLOCK, record: User.first).handle This means you could throw any type of object at it and it it responds to a `call` method wil will be called with all those objects. -:::option `target` + -:::option `context` + -:::option `current_user` + -:::option `view_context` + -:::option `request` + -:::option `params` + -:::option Custom variables + -:::option `helpers` + diff --git a/docs/3.0/field-options.md b/docs/3.0/field-options.md index 7ed128ef..63f4915d 100644 --- a/docs/3.0/field-options.md +++ b/docs/3.0/field-options.md @@ -384,12 +384,12 @@ Now, all fields will have the stacked layout throughout your app. ## Field options -:::option `use_resource` + -:::option `components` + #### Declare the fields from the outside in @@ -639,9 +640,9 @@ field :name, as: :text, html: { Index field wrapper -::: + -:::option `summarizable` + -:::option `for_attribute` + -:::option `meta` + diff --git a/docs/3.0/field-wrappers.md b/docs/3.0/field-wrappers.md index 02b440f7..24af71d8 100644 --- a/docs/3.0/field-wrappers.md +++ b/docs/3.0/field-wrappers.md @@ -19,7 +19,7 @@ Each field displayed on the view is wrapped in this component that reg You may use the component `Avo::Index::FieldWrapperComponent` or the helper `index_field_wrapper`. -:::option `dash_if_blank` + -:::option `center_content` + -:::option `flush` + -:::option `field` + -:::option `resource` + # Show & Edit field wrapper @@ -113,7 +113,7 @@ This space is rarely used and it's there just to fill some horizontal space so t ## Options -:::option `dash_if_blank` + -:::option `compact` + -:::option `data` + -:::option `full_width` + -:::option `form` + -:::option `field` + -:::option `help` + -:::option `label` + -:::option `resource` + -:::option `stacked` + -:::option `style` + -:::option `view` + diff --git a/docs/3.0/fields/badge.md b/docs/3.0/fields/badge.md index 6e687c68..86af62de 100644 --- a/docs/3.0/fields/badge.md +++ b/docs/3.0/fields/badge.md @@ -32,7 +32,7 @@ The `Badge` field is intended to be displayed only on **Index** and **Show** vie ## Options -:::option `options` + ## Examples diff --git a/docs/3.0/fields/boolean.md b/docs/3.0/fields/boolean.md index acece823..e8dfff1d 100644 --- a/docs/3.0/fields/boolean.md +++ b/docs/3.0/fields/boolean.md @@ -19,7 +19,7 @@ field :is_published, ## Options -:::option `true_value` + + diff --git a/docs/3.0/fields/boolean_group.md b/docs/3.0/fields/boolean_group.md index f148db69..16732073 100644 --- a/docs/3.0/fields/boolean_group.md +++ b/docs/3.0/fields/boolean_group.md @@ -38,7 +38,7 @@ field :roles, -:::option `options` + ## Updates diff --git a/docs/3.0/fields/code.md b/docs/3.0/fields/code.md index 70d2aa46..3336efe4 100644 --- a/docs/3.0/fields/code.md +++ b/docs/3.0/fields/code.md @@ -15,7 +15,7 @@ field :custom_css, as: :code, theme: 'dracula', language: 'css' ## Options -:::option `theme` + -:::option `language` + -:::option `height` + -:::option `tab_size` + -:::option `indent_with_tabs` + -:::option `line_wrapping` + diff --git a/docs/3.0/fields/country.md b/docs/3.0/fields/country.md index 3a74714a..16078ed8 100644 --- a/docs/3.0/fields/country.md +++ b/docs/3.0/fields/country.md @@ -22,7 +22,7 @@ field :country, as: :country, display_code: true ## Options -:::option `display_code` + diff --git a/docs/3.0/fields/date.md b/docs/3.0/fields/date.md index b498fdf4..bda21637 100644 --- a/docs/3.0/fields/date.md +++ b/docs/3.0/fields/date.md @@ -18,7 +18,7 @@ field :birthday, ## Options -:::option `format` + + -:::option `picker_options`; + diff --git a/docs/3.0/fields/date_time.md b/docs/3.0/fields/date_time.md index 54cf38de..67cfe6fe 100644 --- a/docs/3.0/fields/date_time.md +++ b/docs/3.0/fields/date_time.md @@ -21,7 +21,7 @@ field :joined_at, ## Options -:::option `format` + + + + -:::option `picker_options` + :::warning These options may override other options like `time_24hr`. diff --git a/docs/3.0/fields/external_image.md b/docs/3.0/fields/external_image.md index abb56d4f..2bc94671 100644 --- a/docs/3.0/fields/external_image.md +++ b/docs/3.0/fields/external_image.md @@ -15,7 +15,7 @@ field :logo, as: :external_image ## Options -:::option `width` + -:::option `height` + -:::option `radius` + diff --git a/docs/3.0/fields/files.md b/docs/3.0/fields/files.md index 1f9d7cbb..9411e718 100644 --- a/docs/3.0/fields/files.md +++ b/docs/3.0/fields/files.md @@ -18,7 +18,7 @@ field :documents, as: :files -:::option `view_type` + -:::option `hide_view_type_switcher` + diff --git a/docs/3.0/fields/gravatar.md b/docs/3.0/fields/gravatar.md index c5dacfe1..2e4fb9b9 100644 --- a/docs/3.0/fields/gravatar.md +++ b/docs/3.0/fields/gravatar.md @@ -16,15 +16,15 @@ field :email, ``` ## Options -:::option `rounded` + -:::option `size` + -:::option `default` + diff --git a/docs/3.0/fields/heading.md b/docs/3.0/fields/heading.md index c662b276..2187b378 100644 --- a/docs/3.0/fields/heading.md +++ b/docs/3.0/fields/heading.md @@ -34,7 +34,7 @@ The computed fields are not rendered on form views, same with heading field, if ## Options -:::option `as_html` + -:::option `label` + diff --git a/docs/3.0/fields/key_value.md b/docs/3.0/fields/key_value.md index d746b11f..f03bb2db 100644 --- a/docs/3.0/fields/key_value.md +++ b/docs/3.0/fields/key_value.md @@ -15,7 +15,7 @@ field :meta, as: :key_value ## Options -:::option `key_label` + -:::option `value_label` + -:::option `action_text` + -:::option `delete_text` + -:::option `disabled` + -:::option `disable_editing_keys` + -:::option `disable_editing_values` + -:::option `disable_adding_rows` + -:::option `disable_deleting_rows` + ## Customizing the labels diff --git a/docs/3.0/fields/location.md b/docs/3.0/fields/location.md index 7ed4625e..a2a299d0 100644 --- a/docs/3.0/fields/location.md +++ b/docs/3.0/fields/location.md @@ -29,7 +29,7 @@ On the view you'll get in interactive map and on the edit you'll get on ## Options -:::option `stored_as` + diff --git a/docs/3.0/fields/markdown.md b/docs/3.0/fields/markdown.md index fe3c1238..cd9eb127 100644 --- a/docs/3.0/fields/markdown.md +++ b/docs/3.0/fields/markdown.md @@ -19,14 +19,14 @@ field :description, as: :markdown ## Options -:::option `always_show` + -:::option `height` + -:::option `spell_checker` + diff --git a/docs/3.0/fields/money.md b/docs/3.0/fields/money.md index 8cb4183e..c6f33e1d 100644 --- a/docs/3.0/fields/money.md +++ b/docs/3.0/fields/money.md @@ -49,7 +49,7 @@ gem "money-rails", "~> 1.12" ## Options -:::option `currencies` + diff --git a/docs/3.0/fields/number.md b/docs/3.0/fields/number.md index 0c136946..ffe234c1 100644 --- a/docs/3.0/fields/number.md +++ b/docs/3.0/fields/number.md @@ -13,7 +13,7 @@ field :age, as: :number ## Options -:::option `min` + -:::option `max` + -:::option `step` + ## Examples diff --git a/docs/3.0/fields/progress_bar.md b/docs/3.0/fields/progress_bar.md index 53a1b463..9f09582a 100644 --- a/docs/3.0/fields/progress_bar.md +++ b/docs/3.0/fields/progress_bar.md @@ -14,7 +14,7 @@ field :progress, as: :progress_bar ## Options -:::option `max` + -:::option `step` + -:::option `display_value` + -:::option `value_suffix` + ## Examples diff --git a/docs/3.0/fields/record_link.md b/docs/3.0/fields/record_link.md index 78dc7d14..8059ca2a 100644 --- a/docs/3.0/fields/record_link.md +++ b/docs/3.0/fields/record_link.md @@ -51,7 +51,7 @@ end Besides some of the [default options](./../field-options.html), there are a few custom ones. -:::option `target` + -:::option `use_resource` + -:::option `add_via_params` + ## Using computed values diff --git a/docs/3.0/fields/select.md b/docs/3.0/fields/select.md index 3b197479..1d08c30e 100644 --- a/docs/3.0/fields/select.md +++ b/docs/3.0/fields/select.md @@ -13,7 +13,7 @@ field :type, as: :select, options: { 'Large container': :large, 'Medium containe ## Options -:::option `options` + -:::option `enum` + -:::option `display_value` + -:::option `include_blank` + ## Computed options diff --git a/docs/3.0/fields/status.md b/docs/3.0/fields/status.md index ebde8ead..0af4569e 100644 --- a/docs/3.0/fields/status.md +++ b/docs/3.0/fields/status.md @@ -21,7 +21,7 @@ field :progress, ## Options -:::option `failed_when` + -:::option `loading_when` + -:::option `success_when` + -:::option `neutral_when` + diff --git a/docs/3.0/fields/tags.md b/docs/3.0/fields/tags.md index cf89228c..c89b35bc 100644 --- a/docs/3.0/fields/tags.md +++ b/docs/3.0/fields/tags.md @@ -16,7 +16,7 @@ field :skills, as: :tags ## Options -:::option `suggestions` + -:::option `suggestions_max_items` + -:::option `close_on_select` + -:::option `acts_as_taggable_on` + -:::option `delimiters` + -:::option `mode` + -:::option `fetch_labels` + -:::option `format_using` + ## PostgreSQL array fields diff --git a/docs/3.0/fields/text.md b/docs/3.0/fields/text.md index 242d631c..8a7ef3e7 100644 --- a/docs/3.0/fields/text.md +++ b/docs/3.0/fields/text.md @@ -12,7 +12,7 @@ field :title, as: :text ``` ## Options -:::option `as_html` + -:::option `protocol` + diff --git a/docs/3.0/fields/textarea.md b/docs/3.0/fields/textarea.md index be88d7cc..c38552da 100644 --- a/docs/3.0/fields/textarea.md +++ b/docs/3.0/fields/textarea.md @@ -14,7 +14,7 @@ field :body, as: :textarea ## Options -:::option `rows` + diff --git a/docs/3.0/fields/time.md b/docs/3.0/fields/time.md index 0f25f737..2f105ce8 100644 --- a/docs/3.0/fields/time.md +++ b/docs/3.0/fields/time.md @@ -22,7 +22,7 @@ field :starting_at, ``` -:::option `format` + -:::option `picker_format` + -:::option `picker_options`; + diff --git a/docs/3.0/fields/trix.md b/docs/3.0/fields/trix.md index 3da6d8db..9ecc3a50 100644 --- a/docs/3.0/fields/trix.md +++ b/docs/3.0/fields/trix.md @@ -19,37 +19,37 @@ Trix field is hidden from the `Index` view. ## Options -:::option `always_show` + -:::option `attachments_disabled` + -:::option `hide_attachment_filename` + -:::option `hide_attachment_filesize` + -:::option `hide_attachment_url` + -:::option `attachment_key` + ## File attachments diff --git a/docs/3.0/gem-server-authentication.md b/docs/3.0/gem-server-authentication.md index 2b12b00e..000e6520 100644 --- a/docs/3.0/gem-server-authentication.md +++ b/docs/3.0/gem-server-authentication.md @@ -50,25 +50,25 @@ Now you are ready to add Avo to your `Gemfile`. Now you can run `bundle install` and `bundler` will pick it up and use it to authenticate on the server. -:::option Heroku + -:::option Hatchbox + -:::option GitHub Actions + -:::option Docker and docker compose + ## FAQ Frequently asked questions: -:::option `Forbidden 403` + diff --git a/docs/3.0/map-view.md b/docs/3.0/map-view.md index 54d08d4b..cc6e61a9 100644 --- a/docs/3.0/map-view.md +++ b/docs/3.0/map-view.md @@ -39,23 +39,23 @@ end You need to add the `mapkick-rb` (not `mapkick`) gem to your `Gemfile` and have the `MAPBOX_ACCESS_TOKEN` environment variable with a valid [Mapbox](https://account.mapbox.com/auth/signup/) key. ::: -:::option `mapkick_options` + -:::option `record_marker` + -:::option `table` + -:::option `extra_markers` + ## Make it the default view diff --git a/docs/3.0/menu-editor.md b/docs/3.0/menu-editor.md index 765bc4e7..c5a6d127 100644 --- a/docs/3.0/menu-editor.md +++ b/docs/3.0/menu-editor.md @@ -89,7 +89,7 @@ end A few menu item types are supported `link_to`, `section`, `group`, `resource`, and `dashboard`. There are a few helpers too, like `all_resources`, `all_dashboards`, and `all_tools`. -:::option `link_to` + -:::option `render` + -:::option `resource` + -:::option `dashboard` + -:::option `section` + -:::option `group` + -:::option `all_resources` + -:::option `all_dashboards` + -:::option `all_tools` + ### `all_` helpers diff --git a/docs/3.0/native-components/avo-panel-component.md b/docs/3.0/native-components/avo-panel-component.md index a3137095..69929fff 100644 --- a/docs/3.0/native-components/avo-panel-component.md +++ b/docs/3.0/native-components/avo-panel-component.md @@ -36,65 +36,65 @@ All options are optional. You may render a panel without options. <% end %> ``` -:::option `name` + -:::option `description` + -:::option `classes` + -:::option `body_classes` + -:::option `data` + -:::option `display_breadcrumbs` + ## Slots The component has a few slots where you customize the content in certain areas. -:::option `tools` + -:::option `body` + -:::option `bare_content` + -:::option `footer_tools` + -:::option `footer` + -:::option `sidebar` + diff --git a/docs/3.0/resource-panels.md b/docs/3.0/resource-panels.md index eeb3fa94..7f0f24f9 100644 --- a/docs/3.0/resource-panels.md +++ b/docs/3.0/resource-panels.md @@ -156,7 +156,7 @@ end Index view -:::option `visible` + diff --git a/docs/3.0/resource-sidebar.md b/docs/3.0/resource-sidebar.md index 0d226bf5..4498bc8a 100644 --- a/docs/3.0/resource-sidebar.md +++ b/docs/3.0/resource-sidebar.md @@ -37,7 +37,7 @@ end The fields will be stacked in a similar way in a narrower area on the side of the main panel. You may notice that inside each field, the tabel and value zones are also stacked one on top of the other to allow for a larger area to display the field value. -:::option panel_wrapper + diff --git a/docs/3.0/resources.md b/docs/3.0/resources.md index c49c4223..5fd68e76 100644 --- a/docs/3.0/resources.md +++ b/docs/3.0/resources.md @@ -407,8 +407,9 @@ end ## Resource Options Resources have a few options available for customization. +``` -:::option `self.title` + -:::option `self.description` + -:::option `self.includes` + -:::option `default_view_type` + -:::option `self.model_class` + -:::option `self.devise_password_optional` + -::::option `self.visible_on_sidebar` + -:::option `config.buttons_on_form_footers` + -:::option `after_create_path`/`after_update_path` + -:::option `self.record_selector` + -:::option `self.link_to_child_resource` + -:::option `self.keep_filters_panel_open` + -:::option `self.components` + - -:::option `self.index_query` + ## Cards @@ -781,7 +782,7 @@ end Alt text -:::option `self.pagination` + -:::option `cache_hash` + diff --git a/docs/3.0/routing.md b/docs/3.0/routing.md index 1fd2bf4f..aebd6976 100644 --- a/docs/3.0/routing.md +++ b/docs/3.0/routing.md @@ -24,7 +24,7 @@ Avo::Engine.routes.draw do end ``` -:::option `Avo.mount_engines` helper + Sometimes you might have more exotic use-cases so you'd like to customize those paths accordingly. diff --git a/docs/3.0/scopes.md b/docs/3.0/scopes.md index f113331a..d6030eef 100644 --- a/docs/3.0/scopes.md +++ b/docs/3.0/scopes.md @@ -63,7 +63,7 @@ end The scope classes take a few options. -:::option `name` + -:::option `description` + -:::option `scope` + -:::option `visible` + diff --git a/docs/3.0/search.md b/docs/3.0/search.md index ef8c261b..baee0c22 100644 --- a/docs/3.0/search.md +++ b/docs/3.0/search.md @@ -102,7 +102,7 @@ Avo.configure do |config| ## Configure the search result -:::option `title` + -:::option `description` + -:::option `image_url` +option `image_format` @@ -193,7 +193,7 @@ end Search avatar -:::option `help` + -:::option `result_path` + -:::option `hide_on_global` + ## Resource search diff --git a/docs/3.0/upgrade.md b/docs/3.0/upgrade.md index ac588c25..9defae0e 100644 --- a/docs/3.0/upgrade.md +++ b/docs/3.0/upgrade.md @@ -5,10 +5,10 @@ We'll update this page when we release new Avo 3 versions. If you're looking for the Avo 2 to Avo 3 upgrade guide, please visit [the dedicated page](./avo-2-avo-3-upgrade). ## Upgrade from 3.10.6 to 3.10.7 -:::option Boolean field + @@ -113,14 +113,14 @@ More on that on this [issue](https://github.com/avo-hq/avo/issues/2844). ## Upgrade from 3.6.1 to 3.6.2 -:::option Cache + ## Upgrade from 3.5.4 to 3.5.5 -:::option Record errors + ## Upgrade from 3.4.2 to 3.4.3 -:::option `turbo` configuration + ## Upgrade from 3.4.1 to 3.4.2 -:::option Basic Filters URL param changed to `encoded_filters` + -:::option Add `active_record_extended` gem to your `Gemfile` + -:::option Multiple action flux + -:::option Action `link_arguments` method + -:::option `resource.record` or `record` as `nil` on visibility blocks + ## Upgrade from 3.3.0 to 3.4.0 Ruby 3.0 is end-of-life and we pushed some code that only works with Ruby 3.1. ## Upgrade from 3.2.2 to 3.3.0 -:::option `may_download_file` deprecated + -:::option Status field `failed_when` and `loading_when` default to and empty array + -:::option Scopes namespace change + -:::option TailwindCSS integration + ## Upgrade from 3.1.3 to 3.1.4 -:::option `Avo::Filters::BaseFilter.decode_filters` + ## Upgrade from 3.0.1.beta24 to 3.0.2 -:::option Sidebar should be declared inside a panel + -:::option Dashboards visibility and authorization + -:::option Actions + -:::option Attachments eager load + ## Upgrade from 3.0.1.beta23 to 3.0.1.beta24 -:::option Cards + ## Upgrade from 3.0.1.beta22 to 3.0.1.beta23 -:::option Caching + ## Upgrade from 3.0.1.beta8 to 3.0.1.beta9 -:::option Heading as field + -:::option Badge field `secondary` option renamed to `neutral` + -:::option Rename `link_to_resource` to `link_to_record` + ## Upgrade from 3.0.1.beta5 to 3.0.1.beta6 -:::option The status field changed behavior + diff --git a/docs/3.0/views.md b/docs/3.0/views.md index ceef060c..93007227 100644 --- a/docs/3.0/views.md +++ b/docs/3.0/views.md @@ -2,34 +2,34 @@ The Avo CRUD feature generates with four main views for each resource. -:::option `Index` + -:::option `Show` + -:::option `Edit` + -:::option `New` + -:::option `Display` + -:::option `Form` + ## Preview diff --git a/docs/common/technical-support.md b/docs/common/technical-support.md index 122d44a0..85450114 100644 --- a/docs/common/technical-support.md +++ b/docs/common/technical-support.md @@ -13,9 +13,6 @@ But, even the best of us get stuck at some point and you might need a nudge in t 2. [Demo apps](#demo-apps) 3. [Paid support](#paid-support) --> - ## Open Source Software Support @@ -44,13 +41,14 @@ For users seeking assistance with application-specific issues, we offer a few pa 2. Advanced hands-on support For more information about our support plans, please visit [this](https://avohq.io/support) page. + ::: ## Self help This is how you can help yourself. -:::option 1. The docs + + + + + ## Help from the official team You sometimes need help from the authors. There are a few ways to do that. -:::option 1. "Thursday is community day" + -:::option 2. Paid support + ## Reproduction repository diff --git a/readme.md b/readme.md index 935d5d0c..fec0b6e3 100644 --- a/readme.md +++ b/readme.md @@ -9,7 +9,7 @@ The second section is the `Options` section marked by an `h2` (`##`) paragraph. We should pass each option following this pattern: ```markdown -:::option `OPTION_NAME_IN_CODE_BLOCK` + ``` After the options, if the field has a lot of options and permutations and you'd like to show more, we can add an `## Examples` block.