From 22d2a523475b6e817cd221fc508171afa15a008c Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Thu, 14 Jan 2021 12:25:58 +0100 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Himanshu Mishra --- docs/plugins/composability.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/plugins/composability.md b/docs/plugins/composability.md index e6f00d2374..5f1be7a561 100644 --- a/docs/plugins/composability.md +++ b/docs/plugins/composability.md @@ -1,8 +1,8 @@ --- id: composability title: Composability System Migration -description: - Documentation and migration instructions for new composability APIs. +# prettier-ignore +description: Documentation and migration instructions for new composability APIs. --- ## Summary @@ -59,7 +59,7 @@ inspected, while our component data adds more structured access and simplifies evolution by allowing for multiple different versions of a piece of data to be used and interpreted at once. -The initial use-cases for component data is support route and plugin discovery +The initial use-case for component data is to support route and plugin discovery through elements in the app. Through this we allow for the React element tree in the app to be the source of truth, both for which plugins are used, as well as all top-level plugin routes in the app. The use of component data is not limited @@ -254,8 +254,8 @@ const headerLinkRouteRef = createExternalRouteRef(); ### Binding External Routes in the App The association of external routes is controlled by the app. Each -`ExternalRouteRef` of a plugin should be<- bound to an actual `RouteRef`, -usually from another plugin. The binding process happens once att app startup, +`ExternalRouteRef` of a plugin should be bound to an actual `RouteRef`, +usually from another plugin. The binding process happens once at app startup, and is then used through the lifetime of the app to help resolve concrete route paths. @@ -517,15 +517,15 @@ It would be ported to this: ```tsx - } + - } + - } + ```