Merge pull request #8315 from adamdmharvey/update-api-ref

chore(docs): Minor updates to improve the API Reference

.changeset/wild-flowers-taste.md

@@ -0,0 +1,7 @@
+---
+'@backstage/theme': patch
+'@backstage/plugin-kubernetes-common': patch
+'@backstage/plugin-sonarqube': patch
+---
+
+Improvements to API Reference documentation

packages/theme/src/index.ts

@@ -15,7 +15,7 @@
  */
 
 /**
- * material-ui theme for use with Backstage.
+ * {@link https://mui.com | material-ui} theme for use with Backstage
  *
  * @packageDocumentation
  */

plugins/kubernetes-common/src/index.ts

@@ -15,7 +15,7 @@
  */
 
 /**
- * Common functionalities for kubernetes, to be shared between kubernetes and kubernetes-backend plugin
+ * Common functionalities for Kubernetes, to be shared between the `kubernetes` and `kubernetes-backend` plugins
  *
  * @packageDocumentation
  */

plugins/sonarqube/api-report.md

@@ -53,6 +53,4 @@ export { sonarQubePlugin };
 // Warnings were encountered during analysis:
 //
 // src/components/SonarQubeCard/SonarQubeCard.d.ts:11:5 - (ae-forgotten-export) The symbol "DuplicationRating" needs to be exported by the entry point index.d.ts
-
-// (No @packageDocumentation comment for this package)
 ```

plugins/sonarqube/src/index.ts

@@ -14,6 +14,13 @@
  * limitations under the License.
  */
 
+/**
+ * A Backstage plugin to display {@link https://www.sonarqube.org | SonarQube}
+ * code quality and security results.
+ *
+ * @packageDocumentation
+ */
+
 export * from './components';
 export {
   sonarQubePlugin,