diff --git a/plugins/backstage-plugin-coder/README.md b/plugins/backstage-plugin-coder/README.md index eb53cb29..657521e2 100644 --- a/plugins/backstage-plugin-coder/README.md +++ b/plugins/backstage-plugin-coder/README.md @@ -47,7 +47,8 @@ the Dev Container. 3. Add the `CoderProvider` to the application: ```tsx - // In packages/app/src/App.tsx + // packages/app/src/App.tsx + import { type CoderAppConfig, CoderProvider, @@ -94,14 +95,26 @@ the Dev Container. 4. Add the `CoderWorkspacesCard` card to the entity page in your app: ```tsx - // In packages/app/src/components/catalog/EntityPage.tsx - import { CoderWorkspacesCard } from '@coder/backstage-plugin-coder'; + // packages/app/src/components/catalog/EntityPage.tsx - // ... + import { CoderWorkspacesCard } from '@coder/backstage-plugin-coder'; - - - ; + // We recommend placing the component inside of overviewContent + const overviewContent = ( + + {entityWarningContent} + + + + + {/* Coder component should go inside Grid to help it work with MUI layouts */} + + + + + {/* Other elements for overviewContent go here */} + + ); ``` ### `app-config.yaml` files