SIT-3007: Add usage reasons to readmes #249
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
README.md
Outdated
|
|
||
| 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 |
There was a problem hiding this comment.
As you can also add custom styling if you are manually integrating, I removed this line. Please let me know your thoughts @jeffpaul
README.md
Outdated
|
|
||
| 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 |
There was a problem hiding this comment.
Made a small change there @jeffpaul let me know what you think.
|
Kudos, SonarCloud Quality Gate passed!
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of the Change
This PR begins to add some rationale as to why a Sophi integration might chose to use the Site Automation block or a custom Query integration. I'm going to look for additional input from @oscarssanchez to ensure this is as detailed as we can, then I'll replicate the update in README.md to readme.txt.
Alternate Designs
n/a
Possible Drawbacks
none identified
Verification Process
Use a markdown viewer to preview the changes in the README.md file.
Checklist:
Changelog Entry
Credits
Props @jeffpaul.