Update Pluggables Framework Documentation #4948
Conversation
✅ Deploy Preview for volto ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
The major change is at line no |
docs/source/recipes/pluggables.md
Outdated
| 'description': "The Pluggables framework give you insertion points to push components to other components in an 'out of tree' fashion, like React's Portal component, but with vitamins." | ||
| 'property=og:description': "The Pluggables framework give you insertion points to push components to other components in an 'out of tree' fashion, like React's Portal component, but with vitamins." | ||
| 'property=og:title': 'Pluggables framework' | ||
| 'keywords': 'Pluggables, framework, React, portal' |
There was a problem hiding this comment.
Revert the above changes, and configure your editor accordingly.
docs/source/recipes/pluggables.md
Outdated
| @@ -57,13 +57,15 @@ Internally, the `<PluggablesProvider>` keeps a record of `Pluggables` and `Plug` | |||
| this is achieved by having the `<Pluggables>` and `<Plug>` components register | |||
| themselves with the Provider via React context. | |||
|
|
|||
| Note: It is important to note that while Pluggables are a powerful framework for enhancing component integration, they are currently not compatible with server-side rendering (SSR). They excel in providing dynamic visual enhancements for CMSUI and client components/widgets. However, when it comes to handling critical data that needs to load quickly, alternative approaches may be more suitable. | |||
There was a problem hiding this comment.
Use MyST syntax and one sentence per line for docs.
| Note: It is important to note that while Pluggables are a powerful framework for enhancing component integration, they are currently not compatible with server-side rendering (SSR). They excel in providing dynamic visual enhancements for CMSUI and client components/widgets. However, when it comes to handling critical data that needs to load quickly, alternative approaches may be more suitable. | |
| ```{note} | |
| While Pluggables are a powerful framework for enhancing component integration, they are currently not compatible with server-side rendering (SSR). | |
| They excel in providing dynamic visual enhancements for the user interface, such as client components and widgets. | |
| However, when it comes to handling critical data that needs to load quickly, alternative approaches may be more suitable. | |
| ``` |
|
@Akshat2Jain this PR needs a change log entry: https://6.docs.plone.org/contributing/index.html#change-log-entry You can ignore the failed docs build, which should be fixed in #4941 |
|
@Akshat2Jain you need to merge the latest changes from
|
There was a problem hiding this comment.
A few quick and easy MyST fixes, and it is good to go!
FYI you can preview the built docs either by doing make docs-html or make docs-livehtml locally, or looking at it in the Netlify link in the pull request on GitHub. By checking the Netlify preview, you can see the problems.
|
@sneridagh this is docs only, and I approve. I'll let you merge and release. |
Description:
This PR updates the documentation for the Pluggables framework to provide a clearer understanding of its capabilities and limitations. The changes aim to improve the clarity and accuracy of the information provided to developers.
Changes Made:
Added a note highlighting that Pluggables are not compatible with server-side rendering (SSR) and are better suited for visual enhancements rather than handling critical data during the loading process.
This Pr fixes #4735