Skip to content

Commit a233b1c

Browse files
committed
docs improvements
1 parent 8d56e2b commit a233b1c

4 files changed

Lines changed: 16 additions & 60 deletions

File tree

docs/.vitepress/theme/index.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import {h} from 'vue';
22
import DefaultTheme from 'vitepress/theme';
33
import './custom.css';
4+
import HomeQuickInstall from './HomeQuickInstall.vue';
45

56
export default {
67
extends: DefaultTheme,
@@ -16,6 +17,7 @@ export default {
1617
'Provide feedback',
1718
),
1819
]),
20+
'home-features-before': () => h(HomeQuickInstall),
1921
});
2022
},
2123
};

docs/guide/index.md

Lines changed: 14 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -4,45 +4,31 @@ description: Introduction to the B2C CLI and SDK for Salesforce Commerce Cloud B
44

55
# Introduction
66

7-
The B2C CLI is a command-line interface for Salesforce Commerce Cloud B2C. It provides tools for:
7+
The B2C CLI is a command-line interface for Salesforce Commerce Cloud B2C — deploy code, manage sandboxes, run jobs, and more from the terminal.
88

9-
- **Code Deployment**: Upload cartridges and activate code versions
10-
- **Site Management**: List and manage sites in your organization
11-
- **Sandbox Management**: Create and manage sandbox environments
12-
- **Managed Runtime (MRT)**: Configure MRT environments and environment variables
9+
## Quick Install
1310

14-
## Packages
11+
::: code-group
1512

16-
This project consists of two packages:
17-
18-
### @salesforce/b2c-cli
19-
20-
The command-line interface that you interact with directly. It provides a set of commands for common B2C Commerce operations.
21-
22-
```bash
23-
# Example: Deploy code to an instance
24-
b2c code deploy --server your-instance.demandware.net
13+
```bash [npm]
14+
npm install -g @salesforce/b2c-cli
2515
```
2616

27-
### @salesforce/b2c-tooling-sdk
28-
29-
The underlying SDK library that powers the CLI. You can use this package directly in your own Node.js applications to automate B2C Commerce operations.
17+
```bash [npx]
18+
npx @salesforce/b2c-cli --help
19+
```
3020

31-
```typescript
32-
import { uploadCartridges, B2CInstance } from '@salesforce/b2c-tooling-sdk';
21+
```bash [Homebrew]
22+
brew install SalesforceCommerceCloud/tools/b2c-cli
23+
```
3324

34-
const instance = new B2CInstance({
35-
server: 'your-instance.demandware.net',
36-
// ... authentication config
37-
});
25+
:::
3826

39-
await uploadCartridges(instance, './cartridges');
40-
```
27+
See [Installation](./installation) for more options.
4128

4229
## Next Steps
4330

44-
- [Installation](./installation) - Install the CLI
4531
- [Authentication Setup](./authentication) - Set up Account Manager, OCAPI, and WebDAV
46-
- [Configuration](./configuration) - Configure CLI options and instances
32+
- [Configuration](./configuration) - Configure instances and credentials
4733
- [CLI Reference](/cli/) - Browse available commands
4834
- [API Reference](/api/) - Explore the SDK API

docs/guide/installation.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,6 @@ brew tap salesforcecommercecloud/tools
4444
brew install b2c-cli
4545
```
4646

47-
## Install from GitHub Releases
48-
49-
Download the latest release tarball from [GitHub Releases](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/releases) and install manually:
50-
51-
```bash
52-
npm install -g ./salesforce-b2c-cli-<version>.tgz
53-
```
54-
5547
## Verify Installation
5648

5749
After installation, verify the CLI is available:

docs/index.md

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -58,30 +58,6 @@ features:
5858
linkText: Learn more
5959
---
6060

61-
## Quick Install
62-
63-
Get started with the CLI in seconds:
64-
65-
::: code-group
66-
67-
```bash [npm]
68-
npm install -g @salesforce/b2c-cli
69-
```
70-
71-
```bash [npx]
72-
npx @salesforce/b2c-cli --help
73-
```
74-
75-
```bash [Homebrew]
76-
brew install SalesforceCommerceCloud/tools/b2c-cli
77-
78-
# or
79-
brew tap SalesforceCommerceCloud/tools
80-
brew install b2c-cli
81-
```
82-
83-
:::
84-
8561
## Packages
8662

8763
| Package | Description |

0 commit comments

Comments
 (0)