@stainless-api/docs 0.1.0-beta.119 → 0.1.0-beta.120

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @stainless-api/docs
 
+## 0.1.0-beta.120
+
+### Patch Changes
+
+- fe6cd04: Improves sidebar item rendering in Terraform
+
 ## 0.1.0-beta.119
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stainless-api/docs",
-  "version": "0.1.0-beta.119",
+  "version": "0.1.0-beta.120",
   "publishConfig": {
     "access": "public"
   },

package/plugin/sidebar-utils/sidebar-builder.ts

@@ -1,6 +1,7 @@
 import type * as SDKJSON from '@stainless/sdk-json';
 import { generateRoute, walkTree, type DocsLanguage } from '@stainless-api/docs-ui/routing';
 import type { StarlightRouteData } from '@astrojs/starlight/route-data';
+import { isResourceEntirelyUnsupported } from '@stainless-api/docs-ui/languages/terraform';
 
 function makeMethodOrResourceKey(entry: SDKJSON.Method | SDKJSON.Resource): string {
   if (entry.kind === 'http_method') {
@@ -249,13 +250,43 @@ export class SidebarConfigItemsBuilder {
     };
   }
 
+  private generateTerraformItems(resources: SDKJSON.Resource[]) {
+    const entries: ReferenceSidebarConfigItem[] = [];
+
+    for (const resource of resources) {
+      if (isResourceEntirelyUnsupported(resource, this.spec.decls['terraform'])) {
+        continue;
+      }
+      entries.push({
+        kind: 'resource_overview_page',
+        label: resource.title,
+        key: makeMethodOrResourceKey(resource),
+        badge: undefined,
+        metadata: {
+          subResourceCount: countKeys(resource.subresources),
+          methodCount: countKeys(resource.methods),
+          modelCount: countKeys(resource.models),
+        },
+      });
+    }
+    return entries;
+  }
+
   public generateItems(): ReferenceSidebarConfigItem[] {
     const resourceMap = this.spec.resources;
     const { resources, sharedModelsResource } = pullOutSharedModelsResource(Object.values(resourceMap ?? {}));
 
-    const entries: ReferenceSidebarConfigItem[] = resources.filter(isResourceNonEmpty).map((r) => {
-      return this.generateResourceGroup(r, false);
-    });
+    let entries: ReferenceSidebarConfigItem[];
+
+    if (this.language === 'terraform') {
+      // Handle Terraform specifically
+      // In TF, we only render the top level resource, not the subresources.
+      entries = this.generateTerraformItems(resources);
+    } else {
+      entries = resources.filter(isResourceNonEmpty).map((r) => {
+        return this.generateResourceGroup(r, false);
+      });
+    }
 
     const includeSharedModels = this.options?.includeSharedModels ?? false;
     if (includeSharedModels && sharedModelsResource) {
@@ -381,10 +412,10 @@ export function toStarlightSidebar({
         throw new Error(`Unknown entry kind ${JSON.stringify(entry)}`);
       }
     } else if (entry.kind === 'group') {
-      // Skip pushing the group if if the resource it represents is not available in the current language.
-      // This occurs when SDK generation for the current language is skipped in the Stainless config for that resource.
       if (entry.resourceGroupKey) {
         const resourceOrMethod = getResourceOrMethod(spec, entry.resourceGroupKey);
+        // Skip pushing the group if if the resource it represents is not available in the current language.
+        // This occurs when SDK generation for the current language is skipped in the Stainless config for that resource.
         if (resourceOrMethod?.data?.kind === 'resource' && !resourceOrMethod?.data?.[currentLanguage]) {
           continue;
         }

package/stl-docs/components/sidebars/BaseSidebar.astro

@@ -73,7 +73,8 @@ function linkGroupTitleToOverviewPages(sidebar: StlSidebarEntry[]): StlSidebarEn
   });
 }
 
-if (LINK_GROUP_TITLES_TO_OVERVIEW_PAGES === true) {
+// Since Terraform only renders the top level resource, we don't need to link group titles to overview pages.
+if (LINK_GROUP_TITLES_TO_OVERVIEW_PAGES === true && Astro.locals.language !== 'terraform') {
   stlSidebar = linkGroupTitleToOverviewPages(stlSidebar);
 }
 ---