docs

Author: erral

README.md

@@ -1,10 +1,48 @@
 # cs_dynamicpages
 
-A new addon for Plone
+A new addon for Plone to create web-based dynamic pages.
 
-## Features
+The concept is pretty similar that of Volto blocks:
 
-TODO: List our awesome features
+- You can build a page using reusable items.
+- Each item can have different fields
+- Each item can have different views
+
+## Provided Content Types
+
+- DynamicPageFolder: this content type will be created in a given folder, and will be the container
+  where all the rows will be added.
+
+- DynamicPageRow: this content type will be the one that will be rendered in a separate row in the view
+
+- DynamicPageRowFeatured: this content type can be used to save static information that can be shown in a
+  row. For instance: each of the items of a slider need a title, a description or an image. They can be added
+  using this content-type
+
+## Provided View
+
+There is just one view `dynamic_view` registered for Folders and Naviation roots
+
+### Different fields
+
+To provide different fields, you should register standard `behaviors` to the `DynamicPageRow`
+content type.
+
+### Different views
+
+To provide different views, you should register standard views (using `zcml`).
+
+Those views must be registered for implementers of `cs_dynamicpages.content.dynamic_page_row.IDynamicPageRow`
+and their name _must_ start by `cs_dynamicpages-`.
+
+### Restrict fields in the row edit view
+
+You may register several behaviors for `DynamicPageRow` objects but only use some of the fields
+provided by them in a given view.
+
+You can restrict which fields are shown in the edit form of the `DynamicPageRow` going to the
+Dynamic Pages Controlpanel, and setting there the list of fields that will be shown when editing
+each of the row types.
 
 ## Installation
 
@@ -27,11 +65,11 @@ make create-site
 
 ### Prerequisites ✅
 
--   An [operating system](https://6.docs.plone.org/install/create-project-cookieplone.html#prerequisites-for-installation) that runs all the requirements mentioned.
--   [uv](https://6.docs.plone.org/install/create-project-cookieplone.html#uv)
--   [Make](https://6.docs.plone.org/install/create-project-cookieplone.html#make)
--   [Git](https://6.docs.plone.org/install/create-project-cookieplone.html#git)
--   [Docker](https://docs.docker.com/get-started/get-docker/) (optional)
+- An [operating system](https://6.docs.plone.org/install/create-project-cookieplone.html#prerequisites-for-installation) that runs all the requirements mentioned.
+- [uv](https://6.docs.plone.org/install/create-project-cookieplone.html#uv)
+- [Make](https://6.docs.plone.org/install/create-project-cookieplone.html#make)
+- [Git](https://6.docs.plone.org/install/create-project-cookieplone.html#git)
+- [Docker](https://docs.docker.com/get-started/get-docker/) (optional)
 
 ### Installation 🔧
 
@@ -48,7 +86,6 @@ make create-site
     make install
     ```
 
-
 ### Add features using `plonecli` or `bobtemplates.plone`
 
 This package provides markers as strings (`<!-- extra stuff goes here -->`) that are compatible with [`plonecli`](https://github.com/plone/plonecli) and [`bobtemplates.plone`](https://github.com/plone/bobtemplates.plone).