From b18c145051ed0ecbfe0ed91e0bed147f9e4be427 Mon Sep 17 00:00:00 2001 From: fullsend-code Date: Tue, 2 Jun 2026 10:28:39 +0000 Subject: [PATCH 1/2] docs(#3271): update boost README with project description, plugin structure, and prerequisites Replace the scaffolded placeholder README with meaningful content: - Expanded project description explaining boost as a rewrite of augment (AI assistant plugin for Backstage) - Planned plugin structure table listing boost, boost-backend, and boost-common packages - Prerequisites section specifying Node 22+ and yarn Closes #3271 Signed-off-by: fullsend-code --- workspaces/boost/README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/workspaces/boost/README.md b/workspaces/boost/README.md index 98959588f0..fed177c37c 100644 --- a/workspaces/boost/README.md +++ b/workspaces/boost/README.md @@ -2,13 +2,20 @@ This workspace contains the Boost plugin family for Red Hat Developer Hub. -Boost is a rewrite of the [Augment](../augment/) plugin. +Boost is a rewrite of the [Augment](../augment/) plugin — an AI assistant plugin for Backstage that provides RAG-powered document search, multi-agent orchestration, tool calling via MCP servers, and safety guardrails, all running against open-source models on your own infrastructure. -## Plugins +## Planned Plugin Structure -| Plugin | Description | -| ------------- | ----------- | -| _coming soon_ | | +| Plugin | Package | Description | +| ---------------- | ---------------------------------------------- | ------------------------------------------------ | +| boost | `@red-hat-developer-hub/backstage-plugin-boost` | Frontend UI — chat interface and agent status | +| boost-backend | `@red-hat-developer-hub/backstage-plugin-boost-backend` | Backend service — API routes, orchestration logic | +| boost-common | `@red-hat-developer-hub/backstage-plugin-boost-common` | Shared types, constants, and utilities | + +## Prerequisites + +- **Node.js** 22 or later +- **Yarn** (see the repository root `.yarnrc.yml` for the pinned version) ## Development From 81c90eafde78fc93c1b2c103ea72796ce20335d0 Mon Sep 17 00:00:00 2001 From: fullsend-fix Date: Tue, 2 Jun 2026 10:42:24 +0000 Subject: [PATCH 2/2] fix: address review feedback on boost README (#3274) - Rename heading from "Planned Plugin Structure" to "Plugins" to match convention used by augment and other workspace READMEs - Switch plugin table to two-column format (Plugin, Description) matching the established augment pattern - Add "planned" note to convey pre-release status without a non-standard heading - Remove Prerequisites section for consistency with other workspace READMEs Addresses review feedback on #3274 Signed-off-by: fullsend-fix --- workspaces/boost/README.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/workspaces/boost/README.md b/workspaces/boost/README.md index fed177c37c..ce31b50b9a 100644 --- a/workspaces/boost/README.md +++ b/workspaces/boost/README.md @@ -4,18 +4,15 @@ This workspace contains the Boost plugin family for Red Hat Developer Hub. Boost is a rewrite of the [Augment](../augment/) plugin — an AI assistant plugin for Backstage that provides RAG-powered document search, multi-agent orchestration, tool calling via MCP servers, and safety guardrails, all running against open-source models on your own infrastructure. -## Planned Plugin Structure +## Plugins -| Plugin | Package | Description | -| ---------------- | ---------------------------------------------- | ------------------------------------------------ | -| boost | `@red-hat-developer-hub/backstage-plugin-boost` | Frontend UI — chat interface and agent status | -| boost-backend | `@red-hat-developer-hub/backstage-plugin-boost-backend` | Backend service — API routes, orchestration logic | -| boost-common | `@red-hat-developer-hub/backstage-plugin-boost-common` | Shared types, constants, and utilities | +The following plugins are planned: -## Prerequisites - -- **Node.js** 22 or later -- **Yarn** (see the repository root `.yarnrc.yml` for the pinned version) +| Plugin | Description | +| --------------------------------------------------------- | ------------------------------------------------ | +| @red-hat-developer-hub/backstage-plugin-boost | Frontend UI — chat interface and agent status | +| @red-hat-developer-hub/backstage-plugin-boost-backend | Backend service — API routes, orchestration logic | +| @red-hat-developer-hub/backstage-plugin-boost-common | Shared types, constants, and utilities | ## Development