docs config

Author: clavery

docs/.vitepress/config.mts

@@ -1,6 +1,28 @@
 import { defineConfig } from 'vitepress';
 import typedocSidebar from '../api/typedoc-sidebar.json';
 
+const guideSidebar = [
+  {
+    text: 'Getting Started',
+    items: [
+      { text: 'Introduction', link: '/guide/' },
+      { text: 'Installation', link: '/guide/installation' },
+      { text: 'Configuration', link: '/guide/configuration' },
+    ],
+  },
+  {
+    text: 'CLI Reference',
+    items: [
+      { text: 'Overview', link: '/cli/' },
+      { text: 'Code Commands', link: '/cli/code' },
+      { text: 'Sites Commands', link: '/cli/sites' },
+      { text: 'Sandbox Commands', link: '/cli/sandbox' },
+      { text: 'MRT Commands', link: '/cli/mrt' },
+      { text: 'Logging', link: '/cli/logging' },
+    ],
+  },
+];
+
 export default defineConfig({
   title: 'B2C CLI',
   description: 'Salesforce Commerce Cloud B2C Command Line Tools',
@@ -28,28 +50,8 @@ export default defineConfig({
     },
 
     sidebar: {
-      '/guide/': [
-        {
-          text: 'Getting Started',
-          items: [
-            { text: 'Introduction', link: '/guide/' },
-            { text: 'Installation', link: '/guide/installation' },
-            { text: 'Configuration', link: '/guide/configuration' },
-          ],
-        },
-      ],
-      '/cli/': [
-        {
-          text: 'CLI Reference',
-          items: [
-            { text: 'Overview', link: '/cli/' },
-            { text: 'Code Commands', link: '/cli/code' },
-            { text: 'Sites Commands', link: '/cli/sites' },
-            { text: 'Sandbox Commands', link: '/cli/sandbox' },
-            { text: 'MRT Commands', link: '/cli/mrt' },
-          ],
-        },
-      ],
+      '/guide/': guideSidebar,
+      '/cli/': guideSidebar,
       '/api/': [
         {
           text: 'API Reference',

docs/api-readme.md

@@ -0,0 +1,24 @@
+# API Reference
+
+The `@salesforce/b2c-tooling` package provides a programmatic API for interacting with Salesforce B2C Commerce instances.
+
+## Installation
+
+```bash
+npm install @salesforce/b2c-tooling
+```
+
+## Quick Start
+
+```typescript
+import { B2CInstance } from '@salesforce/b2c-tooling/instance';
+import { OAuthStrategy } from '@salesforce/b2c-tooling/auth';
+
+const instance = new B2CInstance({
+  hostname: 'your-instance.salesforce.com',
+  auth: new OAuthStrategy({
+    clientId: 'your-client-id',
+    clientSecret: 'your-client-secret',
+  }),
+});
+```

typedoc.json

@@ -13,7 +13,7 @@
   "out": "./docs/api",
   "plugin": ["typedoc-plugin-markdown", "typedoc-vitepress-theme"],
   "tsconfig": "./packages/b2c-tooling/tsconfig.json",
-  "readme": "none",
+  "readme": "./docs/api-readme.md",
   "excludePrivate": true,
   "excludeProtected": true,
   "excludeInternal": true,