From a41a02c4a59d0210eb1a0ce39a91fb6af6e2dab5 Mon Sep 17 00:00:00 2001
From: Charles de Dreuille <charles.dedreuille@gmail.com>
Date: Tue, 26 Nov 2024 13:54:43 +0000
Subject: [PATCH] Add @packageDocumentation

Signed-off-by: Charles de Dreuille <charles.dedreuille@gmail.com>
---
 packages/canon/report.api.md | 2 --
 packages/canon/src/index.ts  | 7 ++++++-
 2 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/packages/canon/report.api.md b/packages/canon/report.api.md
index 4cf5ac8869..01a295256d 100644
--- a/packages/canon/report.api.md
+++ b/packages/canon/report.api.md
@@ -2625,6 +2625,4 @@ export const IconProvider: ({
   children: ReactNode;
   overrides: Partial<Record<IconNames, React_2.ComponentType>>;
 }) => React_2.JSX.Element;
-
-// (No @packageDocumentation comment for this package)
 ```
diff --git a/packages/canon/src/index.ts b/packages/canon/src/index.ts
index 85b6be2bc0..38bcc3b77c 100644
--- a/packages/canon/src/index.ts
+++ b/packages/canon/src/index.ts
@@ -14,7 +14,12 @@
  * limitations under the License.
  */
 
-// Components
+/**
+ * Components used by Backstage plugins and apps
+ *
+ * @packageDocumentation
+ */
+
 export * from './components/button';
 export * from './components/box';
 export * from './components/icon';