docs: Update documentation (#259)

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

Author: fsbraun

README.rst

@@ -4,60 +4,60 @@
 
 |pypi| |docs| |coverage| |python| |django| |djangocms| |djangocms4|
 
-**django CMS Frontend** is a powerful plugin suite designed to streamline the
-integration of frontend frameworks into django CMS. Out of the box, it provides
-comprehensive support for Bootstrap 5, while also enabling the use of other
-CSS frameworks, such as Tailwind CSS, through custom components.
-Whether you're building responsive layouts or highly customized designs,
-django CMS Frontend is designed to simplify your development workflow.
+django CMS Frontend is a versatile plugin suite for django CMS that facilitates
+the easy creation of reusable frontend components. It supports any CSS framework,
+allowing developers to seamlessly integrate their preferred styling libraries.
+For immediate use, it includes a comprehensive set of Bootstrap 5 components
+and templates.
+
 
 .. image:: preview.png
 
 Key features
 ============
 
-- **Easy to implement re-usable frontend custom components**, which in the
-  simplest case consist of a template and declarative sort of form class.
-
-- Support of `Bootstrap 5 <https://getbootstrap.com>`_, django CMS 3.8+
-  and django CMS 4 out of the box.
+* **Effortless Development of Custom Components**: Create reusable frontend
+  components with ease, utilizing simple templates and declarative form
+  classes. These components can function both as CMS plugins and within
+  standard Django templates. ​
 
-- Support of other frameworks such as `Tailwind CSS <https://tailwindcss.com>`_
-  through custom components.
+* **Framework-Agnostic Design**: Maintain flexibility in your project's design
+  by decoupling plugins from specific versions of a CSS framework. This ensures
+  that updating frameworks in the future doesn't necessitate rebuilding your
+  site's plugin structure. ​
 
-- **Separation of plugins from css framework**, i.e. no need to
-  rebuild you site's plugin tree if css framework is changed in the
-  future, e.g. from Bootstrap 5 to a future version.
+* **Pre-Integrated Bootstrap 5 Components**: Access a ready-to-use collection
+  of Bootstrap 5 components, streamlining the process of building responsive
+  and modern interfaces. ​
 
-- **Plugins are re-usable as UI components** anywhere in your project
-  (e.g. in a custom app) giving your whole project a more consistent
-  user experience.
-
-- **Extensible** within the project and with separate project (e.g. a
-  theme app). Create your own components with a few lines of code only.
+* **Extensibility**: Enhance your project by creating custom components with
+  minimal code. The system is designed to be extended both within individual
+  projects and through separate theme applications. ​
 
+* **Consistent User Experience**: Utilize plugins as UI components throughout
+  your project, promoting a cohesive and uniform user interface. ​
 
 
 Description
 ===========
-django CMS Frontend is framework agnostic but comes with support of selected
-components of Bootstrap 5. Components can have different templates for different
-frameworks and the preferred framework can be set in the project settings.
 
-It is up to you which (if any at all) components you want to include in your
-project. Each set of components is a separate package you can include in your
-project's ``INSTALLED_APPS``.
+Designed to be framework-agnostic, django CMS Frontend allows developers to
+select and change CSS frameworks by adjusting project settings, eliminating
+the need to reconstruct the CMS plugin tree when upgrading or switching
+frameworks. It leverages `django-entangled
+<https://github.com/jrief/django-entangled>`_ to store design parameters in
+a common JSON field, preventing database bloat and facilitating seamless
+updates to frontend features.
 
-The components are designed to be re-usable as UI components in your
-project, e.g. in a custom app, giving your whole project a more
-consistent user experience.
+By providing a suite of Bootstrap 5-based components for layout structuring,
+including grids, components, and forms, django CMS Frontend simplifies the
+process of building responsive and structured page designs. Developers can
+also create custom components with minimal code, ensuring a consistent and
+efficient development experience.
 
-django CMS Frontend uses `django-entangled
-<https://github.com/jrief/django-entangled>`_ by Jacob Rief to avoid
-bloating your project's database with css framework-dependent tables.
-Instead all design parameters are stored in a common JSON field and
-future releases of improved frontend features will not require to
-rebuild your full plugin tree.
+It is up to you which (if any at all) pre-built components you want to include
+in your project. Each set of components is a separate package you can include
+in your project's ``INSTALLED_APPS``.
 
 
 Contributing
@@ -116,6 +116,7 @@ For a manual install:
    .. code::
 
       'easy_thumbnails',
+      'djangocms_link',  # Needed for link support
       'djangocms_frontend',
       'djangocms_frontend.contrib.accordion',  # optional
       'djangocms_frontend.contrib.alert',  # optional
@@ -144,7 +145,6 @@ install separately or by adding an option:
     pip install djangocms-frontend[djangocms-icon]  # Installs djangocms-icon for icon support in links
 
 
-
 Documentation
 =============
 
@@ -174,5 +174,5 @@ See `LICENSE <https://github.com/django-cms/djangocms-frontend/blob/master/LICEN
 .. |djangocms| image:: https://img.shields.io/badge/django%20CMS-3.8%2B-blue.svg
    :target: https://www.django-cms.org/
 
-.. |djangocms4| image:: https://img.shields.io/badge/django%20CMS-4-blue.svg
+.. |djangocms4| image:: https://img.shields.io/badge/django%20CMS-4%2B-blue.svg
    :target: https://www.django-cms.org/en/preview-django-cms-40/

djangocms_frontend/component_base.py

@@ -50,7 +50,7 @@ class CMSFrontendComponent(forms.Form):
     _admin_form = None
     _model = None
     _plugin = None
-    META_FIELDS = ["is_local", "disable_edit", "disable_child_plugins", "show_plugin_add_form",
+    META_FIELDS = ["is_local", "disable_edit", "disable_child_plugins", "show_add_form",
                    "frontend_editable_fields", "link_fieldset_position", "require_parent",
                    "parent_classes"]
 

djangocms_frontend/contrib/accordion/cms_plugins.py

@@ -73,7 +73,7 @@ class AccordionItemPlugin(mixin_factory("AccordionItem"), CMSUIPlugin):
     model = models.AccordionItem
     form = forms.AccordionItemForm
     allow_children = True
-    show_plugin_add_form = False
+    show_add_form = False
 
     parent_classes = [
         "AccordionPlugin",

djangocms_frontend/contrib/content/cms_plugins.py

@@ -63,6 +63,7 @@ class BlockquotePlugin(
     form = forms.BlockquoteForm
     change_form_template = "djangocms_frontend/admin/blockquote.html"
     allow_children = True
+    frontend_editable_fields = ("quote_content", "quote_origin")
 
     fieldsets = [
         (
@@ -77,8 +78,6 @@ class BlockquotePlugin(
         ),
     ]
 
-    frontend_editable_fields = ("quote_content", "quote_origin")
-
 
 @plugin_pool.register_plugin
 class FigurePlugin(
@@ -100,6 +99,7 @@ class FigurePlugin(
     form = forms.FigureForm
     change_form_template = "djangocms_frontend/admin/figure.html"
     allow_children = True
+    frontend_editable_fields = ("figure_caption",)
 
     fieldsets = [
         (
@@ -112,5 +112,3 @@ class FigurePlugin(
             },
         ),
     ]
-
-    frontend_editable_fields = ("figure_caption",)

djangocms_frontend/contrib/grid/cms_plugins.py

@@ -35,7 +35,7 @@ class GridContainerPlugin(
     form = forms.GridContainerForm
     change_form_template = "djangocms_frontend/admin/grid_container.html"
     allow_children = True
-    show_plugin_add_form = False
+    show_add_form = False
 
     fieldsets = [
         (
@@ -153,7 +153,7 @@ class GridColumnPlugin(
     # TODO it should allow for the responsive utility class
     # https://getbootstrap.com/docs/5.0/layout/grid/#column-resets
     parent_classes = ["GridRowPlugin"]
-    show_plugin_add_form = False
+    show_add_form = False
 
     fieldsets = [
         (

djangocms_frontend/contrib/link/migrations/0002_rename_plugin.py

@@ -14,7 +14,6 @@ class Migration(migrations.Migration):
         ('link', '0001_initial'),
     ]
 
-
     operations = [
         migrations.RunPython(
             lambda apps, schema_editor: rename(apps, "Link", "TextLink"),

djangocms_frontend/contrib/listgroup/cms_plugins.py

@@ -29,7 +29,8 @@ class ListGroupPlugin(
     form = forms.ListGroupForm
     change_form_template = "djangocms_frontend/admin/list-group.html"
     allow_children = True
-    child_classes = ["ListGroupItemPlugin", "LinkPlugin"]
+    child_classes = ["ListGroupItemPlugin", "TextLinkPlugin"]
+    show_add_form = False
     # TODO consider linking to tab-content
 
     fieldsets = [
@@ -57,6 +58,7 @@ class ListGroupItemPlugin(
     change_form_template = "djangocms_frontend/admin/list-group.html"
     allow_children = True
     parent_classes = ["ListGroupPlugin"]
+    frontend_editable_fields = ("simple_content",)
 
     fieldsets = [
         (

djangocms_frontend/contrib/media/cms_plugins.py

@@ -23,6 +23,7 @@ class MediaPlugin(mixin_factory("Media"), AttributesMixin, ResponsiveMixin, CMSU
     form = forms.MediaForm
     change_form_template = "djangocms_frontend/admin/media.html"
     allow_children = True
+    show_add_form = False
 
     fieldsets = settings.EMPTY_FIELDSET
 
@@ -41,5 +42,6 @@ class MediaBodyPlugin(mixin_factory("MediaBody"), AttributesMixin, CMSUIPlugin):
     change_form_template = "djangocms_frontend/admin/media.html"
     allow_children = True
     parent_classes = ["MediaPlugin"]
+    show_add_form = False
 
     fieldsets = settings.EMPTY_FIELDSET

djangocms_frontend/contrib/navigation/cms_plugins.py

@@ -82,6 +82,7 @@ class PageTreePlugin(
     parent_classes = [
         "NavigationPlugin",
     ]
+    show_add_form = False
     fieldsets = [
         (
             None,

djangocms_frontend/contrib/tabs/cms_plugins.py

@@ -27,6 +27,7 @@ class TabPlugin(mixin_factory("Tab"), AttributesMixin, CMSUIPlugin):
     change_form_template = "djangocms_frontend/admin/tabs.html"
     allow_children = True
     child_classes = ["TabItemPlugin"]
+    show_add_form = False
 
     fieldsets = [
         (
@@ -59,6 +60,7 @@ class TabItemPlugin(mixin_factory("TabItem"), AttributesMixin, PaddingMixin, CMS
     change_form_template = "djangocms_frontend/admin/tabs.html"
     allow_children = True
     parent_classes = ["TabPlugin"]
+    show_add_form = False
 
     fieldsets = [
         (