From 2fa0d45cfdbf07a25b2edd0dd19caee10181c600 Mon Sep 17 00:00:00 2001 From: Jeffrey Paul Date: Tue, 26 Apr 2022 08:30:43 -0500 Subject: [PATCH 1/4] add usage reasons in README.md --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 05b99060..b978e188 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,20 @@ Once your credentials are validated and saved, your site is officially superchar ## Usage -There are two ways that Sophi Site Automation results can be included in a WordPress site, via a Site Automation block and a direct integration with WP_Query. More details on each of these options are described below. +There are two ways that Sophi Site Automation results can be included in a WordPress site, via a Site Automation block and a direct integration with WP_Query. More details on each of these options are described below. If you are not certain on the best integration approach, considering the following: + +Reasons to use the Site Automation block: +- No additional development effort needed for initial Sophi integration +- Immediate integration with Sophi Site Automation API and page/widget settings +- Basic block display settings allow for basic configurations (show/hide post excerpt, author name, post date, featured image) +- Supports advanced CSS for further custom styling + +Reasons to use the Query integration: +- Can implement more custom caching and content fallback options +- Can implement support into non-block editor setups +- Likely more flexible for headless setups +- Block editor is not in-use within your WordPress environment +- Blocks are not available on category/taxonomy pages ### Site Automation block From bdd8b82f5377ff182cb167cfb0642013bf5166c8 Mon Sep 17 00:00:00 2001 From: Oscar Sanchez S Date: Wed, 27 Apr 2022 11:14:21 -0500 Subject: [PATCH 2/4] Update documentation --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b978e188..24297fad 100644 --- a/README.md +++ b/README.md @@ -70,20 +70,21 @@ Once your credentials are validated and saved, your site is officially superchar ## Usage -There are two ways that Sophi Site Automation results can be included in a WordPress site, via a Site Automation block and a direct integration with WP_Query. More details on each of these options are described below. If you are not certain on the best integration approach, considering the following: +There's two potential ways to integrate Sophi automation results with your WordPress site. As default, Sophi includes a block that integrates with a WP_Query by injecting posts id's via the `posts_pre_query` filter which later get fetched to return actual posts. In the same fashion, you can integrate Sophi results with your WP_Query object by setting the `sophi_curated_page` and `sophi_curated_widget` query parameters. + +More details on each of these two options are described below. If you are not certain on the best integration approach, considering the following: Reasons to use the Site Automation block: - No additional development effort needed for initial Sophi integration - Immediate integration with Sophi Site Automation API and page/widget settings - Basic block display settings allow for basic configurations (show/hide post excerpt, author name, post date, featured image) -- Supports advanced CSS for further custom styling Reasons to use the Query integration: - Can implement more custom caching and content fallback options - Can implement support into non-block editor setups - Likely more flexible for headless setups - Block editor is not in-use within your WordPress environment -- Blocks are not available on category/taxonomy pages +- You need integration with category/taxonomy pages and can't integrate using a sidebar widget ### Site Automation block From df7598394a11e5f1fef2d2ab2e13a2005cc61994 Mon Sep 17 00:00:00 2001 From: Jeffrey Paul Date: Wed, 27 Apr 2022 11:59:21 -0500 Subject: [PATCH 3/4] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d8d3e65f..3e88608e 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ Once your credentials are validated and saved, your site is officially superchar ## Usage -There's two potential ways to integrate Sophi automation results with your WordPress site. As default, Sophi includes a block that integrates with a WP_Query by injecting posts id's via the `posts_pre_query` filter which later get fetched to return actual posts. In the same fashion, you can integrate Sophi results with your WP_Query object by setting the `sophi_curated_page` and `sophi_curated_widget` query parameters. +There are two potential ways to integrate Sophi Site Automation results with your WordPress site. The default approach includes a Sophi Site Automation block that integrates with `WP_Query` by injecting Posts IDs via the `posts_pre_query` filter that gets fetched later to return the actual Posts. In the same fashion, you can integrate Sophi results with your `WP_Query` object by setting the `sophi_curated_page` and `sophi_curated_widget` query parameters. More details on each of these two options are described below. If you are not certain on the best integration approach, considering the following: @@ -84,7 +84,7 @@ Reasons to use the Query integration: - Can implement support into non-block editor setups - Likely more flexible for headless setups - Block editor is not in-use within your WordPress environment -- You need integration with category/taxonomy pages and can't integrate using a sidebar widget +- You need an integration with Category/Taxonomy Pages and cannot integrate using a sidebar widget ### Site Automation block From d56c34a7004a45f52e18c39d503bfa25d3b106a5 Mon Sep 17 00:00:00 2001 From: Jeffrey Paul Date: Wed, 27 Apr 2022 12:01:01 -0500 Subject: [PATCH 4/4] mirror README.md changes to readme.txt --- readme.txt | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/readme.txt b/readme.txt index 4881b809..05059dee 100644 --- a/readme.txt +++ b/readme.txt @@ -50,7 +50,21 @@ Once your credentials are validated and saved, your site is officially superchar == Usage == -There are two ways that Sophi Site Automation results can be included in a WordPress site, via a Site Automation block and a direct integration with WP_Query. More details on each of these options are described below. +There are two potential ways to integrate Sophi Site Automation results with your WordPress site. The default approach includes a Sophi Site Automation block that integrates with `WP_Query` by injecting Posts IDs via the `posts_pre_query` filter that gets fetched later to return the actual Posts. In the same fashion, you can integrate Sophi results with your `WP_Query` object by setting the `sophi_curated_page` and `sophi_curated_widget` query parameters. + +More details on each of these two options are described below. If you are not certain on the best integration approach, considering the following: + +Reasons to use the Site Automation block: +- No additional development effort needed for initial Sophi integration +- Immediate integration with Sophi Site Automation API and page/widget settings +- Basic block display settings allow for basic configurations (show/hide post excerpt, author name, post date, featured image) + +Reasons to use the Query integration: +- Can implement more custom caching and content fallback options +- Can implement support into non-block editor setups +- Likely more flexible for headless setups +- Block editor is not in-use within your WordPress environment +- You need an integration with Category/Taxonomy Pages and cannot integrate using a sidebar widget = Site Automation block =