Add docs for GithubAppConfig

packages/integration/src/github/config.ts

@@ -67,13 +67,34 @@ export type GitHubIntegrationConfig = {
   apps?: GithubAppConfig[];
 };
 
+/**
+ * The configuration parameters for authenticating a GitHub Application.
+ * A Github Apps configuration can be generated using the `backstage-cli create-github-app` command.
+ */
 export type GithubAppConfig = {
+  /**
+   * Unique app identifier, found at https://github.com/organizations/$org/settings/apps/$AppName
+   */
   appId: number;
+  /**
+   * The private key is used by the GitHub App integration to authenticate the app.
+   * A private key can be generated from the app at https://github.com/organizations/$org/settings/apps/$AppName
+   */
   privateKey: string;
+  /**
+   * Webhook secret can be configured at https://github.com/organizations/$org/settings/apps/$AppName
+   */
   webhookSecret: string;
+  /**
+   * Found at https://github.com/organizations/$org/settings/apps/$AppName
+   */
   clientId: string;
+  /**
+   * Client secrets can be generated at https://github.com/organizations/$org/settings/apps/$AppName
+   */
   clientSecret: string;
 };
+
 /**
  * Reads a single GitHub integration config.
  *