enh: add documentation for snap-in build config

fern/docs/pages/references/build-config.mdx

@@ -0,0 +1,61 @@
+The build configuration is used to configure the build process of the snap-in. For example, it can be used to set the environment variables used during the build process.
+
+This is useful if the developer wants to import libraries from a different registry or wants to use private packages that
+require an authentication token.
+
+## Specifying the config
+
+Build config is defined as:
+
+```yaml
+build_config:
+  environment_variables:
+    - name: <Name of the environment variable>
+      description: <Description of what the environment variable does>
+      type: <Whether the value is a `constant` or in a developer `keyring`>
+      value: <variable value or developer keyring name>
+```
+
+For example, to import a library that uses the GitHub NPM registry, add
+the following variables to the build config:
+
+```yaml
+build_config:
+  environment_variables:
+    - name: REGISTRY_NAME
+      description: Name of the GitHub registry to import the library.
+      type: constant
+      value: npm.pkg.github.com
+    - name: AUTH_TOKEN
+      description: Token to access the registry
+      type: keyring
+      value: access_token
+```
+
+Since "AUTH_TOKEN" is sensitive information that should not be hardcoded in the manifest,
+the developer can instead mention the name of the developer keyring and, during snap-in version creation
+time, provide the developer keyring to take the value from.
+
+```yaml
+developer_keyrings:
+  - name: access_token
+    description: Access token for the GitHub registry
+    display_name: Access Token
+```
+
+## Using the variables defined in config
+
+If the package is present in private registries, the developer can update the `.npmrc` file in the `code` folder from the template to include the URL of the registry and the token.
+
+For example, to use variables defined in the manifest defined in the previous section, the `.npmrc` file will look something like this:
+
+```.npmrc
+@githubReg:registry=https://${REGISTRY_NAME}
+//${REGISTRY_NAME}/:_authToken=${AUTH_TOKEN}
+```
+
+To ensure that the `.npmrc` file is valid and can be used to install the libraries, export the variables defined in the manifest locally with the correct values and install the library
+
+```
+  npm install @githubReg/<YOUR_LIBRARY>
+```

fern/docs/pages/references/manifest.mdx

@@ -1,5 +1,7 @@
 <Callout intent="note">
-The following section is for version 2 of the manifest specification. For the previous version, see [Manifest V1](/snapin-development/references/v1-manifest).
+  The following section is for version 2 of the manifest specification. For the
+  previous version, see [Manifest
+  V1](/snapin-development/references/v1-manifest).
 </Callout>
 
 The snap-in manifest is what the developers write to define a snap-in. The manifest has the following sections:
@@ -57,6 +59,7 @@ keyrings:
         - snap_in_secret
       display_name: Your secret token
 ```
+
 Keyrings defined in the manifest can be provided in the snap-in configuration screens and are made available to the function. The keyring type is used to determine the type of the keyring and restricts selection on the configuration screen to valid types.
 
 Organization keyrings are common to the organization, while user keyrings are set per user. User keyrings are optional, so the developer must correctly handle cases where the keyring isn't found.
@@ -654,7 +657,7 @@ event_sources:
 
 ## Inputs
 
-Inputs are implemented using per-object schemas, which is a customization technique to store custom schemas inline with the object. Each input's schema maps to a FieldDescriptor. Inputs, like keyrings and event sources, are organization and user scoped. Organization-scoped inputs are set by the admins of the organization and are common across all users. User inputs are set individually.
+Inputs are implemented using per-object schemas, which is a customization technique to store custom schemas in line with the object. Each input's schema maps to a `FieldDescriptor`. Inputs, like keyrings and event sources, are organization and user-scoped. Organization-scoped inputs are set by the admins of the organization and are common across all users. User inputs are set individually.
 
 Inputs are defined as:
 
@@ -679,7 +682,8 @@ inputs:
       ui:
         display_name: <Input field display name.>
 ```
-Inputs of type `timestamp`, `date` and `array` of `booleans` aren't supported. 
+
+Inputs of type `timestamp`, `date`, and `array` of `booleans` aren't supported.
 
 ## Tags
 
@@ -690,7 +694,7 @@ For example:
 ```yaml
 tags:
   - name: github.branch.name
-    description: Tag storing github branch name.
+    description: Tag storing GitHub branch name.
 ```
 
 ## Commands
@@ -706,7 +710,7 @@ commands:
       - surface: discussions
         object_types:
           - conversation
-    usage_hint: "number of tokens to generate"
+    usage_hint: 'number of tokens to generate'
     function: generate_summary
 ```
 
@@ -743,3 +747,26 @@ automations:
 ```
 
 For custom event sources, whatever event key you emit from your policy, the event name will be `custom:<your event key>`.
+
+## Build config
+
+The build configuration is used to configure the build process of the snap-in. For example, it can be used to set the environment variables used during the build process. This is useful if the snap-in requires libraries that
+are either private or from a different npm registry than the default.
+
+Build config is defined as:
+
+```yaml
+build_config:
+  environment_variables:
+    - name: <Name of the environment variable>
+      description: <Description of what the environment variable does>
+      type: <Whether the value is a constant or in a developer keyring>
+      value: <variable value or developer keyring name>
+```
+
+`type` can either be `constant` or `keyring`.
+
+`value` is either the actual value of the environment variable or name of the developer keyring that
+contains the secret depending on the type being `constant` or `keyring`.
+
+For further information, see [Build Config](/references/build-config).

fern/versions/public.yml

@@ -150,6 +150,9 @@ navigation:
           - page: Snap-in resources
             slug: snap-in-resources
             path: ../docs/pages/references/snap-in-resources.mdx
+          - page: Build Config
+            slug: build-config
+            path: ../docs/pages/references/build-config.mdx
       - page: Development best practices
         slug: best-practices
         path: ../docs/pages/best_practices.mdx