Merge pull request #25537 from adamdmharvey/ah-api-docs

chore: Improve API Reference documentation

.changeset/famous-clocks-visit.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-permission-node': patch
+---
+
+Fix invalid cross-reference in API Reference docs

.changeset/tender-turkeys-begin.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-permission-react': patch
+---
+
+Improve API Reference documentation

packages/repo-tools/src/commands/api-reports/api-extractor.ts

@@ -145,7 +145,7 @@ ApiReportGenerator.generateReviewFileContent =
           if (!localName) {
             // Sometimes the symbol name is suffixed with a number to disambiguate,
             // e.g. "Props_14" instead of "Props" if there are multiple Props interfaces
-            // so we tyry to strip that suffix and look up the symbol again.
+            // so we try to strip that suffix and look up the symbol again.
             const [, trimmedSymbolName] = symbolName.match(/(.*)_\d+/) || [];
             localName = (sourceFile as any).identifiers?.get(trimmedSymbolName);
           }

plugins/permission-node/src/types.ts

@@ -23,7 +23,7 @@ import { NoInfer } from './integration/util';
 
 /**
  * A conditional rule that can be provided in an
- * {@link @backstage/permission-common#AuthorizeDecision} response to an authorization request.
+ * {@link @backstage/plugin-permission-common#AuthorizeDecision} response to an authorization request.
  *
  * @remarks
  *

plugins/permission-react/api-report.md

@@ -100,6 +100,4 @@ export function usePermission(
         resourceRef: string | undefined;
       },
 ): AsyncPermissionResult;
-
-// (No @packageDocumentation comment for this package)
 ```

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';