From 09086e8d0ae82ca18f1e2a476bff60278af872f6 Mon Sep 17 00:00:00 2001
From: Adam Harvey <33203301+adamdmharvey@users.noreply.github.com>
Date: Fri, 5 Jul 2024 23:34:53 -0400
Subject: [PATCH] chore: Add packageDocumentation for API Docs Index

Signed-off-by: Adam Harvey <33203301+adamdmharvey@users.noreply.github.com>
---
 plugins/permission-react/api-report.md | 2 --
 plugins/permission-react/src/index.ts  | 5 +++++
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/plugins/permission-react/api-report.md b/plugins/permission-react/api-report.md
index 3c1961c92c..4c51d16b80 100644
--- a/plugins/permission-react/api-report.md
+++ b/plugins/permission-react/api-report.md
@@ -100,6 +100,4 @@ export function usePermission(
         resourceRef: string | undefined;
       },
 ): AsyncPermissionResult;
-
-// (No @packageDocumentation comment for this package)
 ```
diff --git a/plugins/permission-react/src/index.ts b/plugins/permission-react/src/index.ts
index 57352c5cdd..de6958b3e5 100644
--- a/plugins/permission-react/src/index.ts
+++ b/plugins/permission-react/src/index.ts
@@ -14,6 +14,11 @@
  * limitations under the License.
  */
 
+/**
+ * Components and hooks to help implement permissions in Backstage frontend plugins.
+ *
+ * @packageDocumentation
+ */
 export * from './components';
 export * from './hooks';
 export * from './apis';