Skip to content

Commit 121f6f2

Browse files
allister-beamableclaude
allister-beamable
and
claude
committed
Cleanup: remove trailing whitespace across all Markdown and YAML files.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 29ed7c3 commit 121f6f2

97 files changed

Lines changed: 1537 additions & 1537 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/auto-publish-branch.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ jobs:
3535
id: version
3636
run: |
3737
BRANCH="${{ github.ref_name }}"
38-
38+
3939
# Extract the product prefix (before the first /)
4040
PRODUCT_PREFIX="${BRANCH%%/*}"
41-
41+
4242
# Map branch prefix to product name
4343
case "$PRODUCT_PREFIX" in
4444
unity)
@@ -111,7 +111,7 @@ jobs:
111111
if: steps.check.outputs.published == 'false'
112112
run: echo "Skipping — ${{ steps.version.outputs.mike_alias }} has not been manually published yet."
113113

114-
114+
115115

116116
# Confirm mkdocs.yml is present before attempting a deploy
117117
- name: Verify mkdocs.yml exists
@@ -135,7 +135,7 @@ jobs:
135135
run: mike deploy "${{ steps.version.outputs.mike_alias }}" --branch gh-pages --push
136136

137137
- name: Notify Slack
138-
# if: steps.check.outputs.published == 'true'
138+
# if: steps.check.outputs.published == 'true'
139139
if: false
140140
env:
141141
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_DOCS_CHANNEL_URL }}

‎.github/workflows/auto-sync-core.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ jobs:
6262
with:
6363
token: ${{ secrets.DOCS_PAT }}
6464
title: "Merge ${{ github.ref_name }} into ${{ matrix.branch }} (Conflicts)"
65-
body: The ${{ github.ref_name }} branch was unable to merge into ${{ matrix.branch }}. Please review the changes.
65+
body: The ${{ github.ref_name }} branch was unable to merge into ${{ matrix.branch }}. Please review the changes.
6666
branch: merge-${{ github.ref_name }}-into-${{ matrix.branch }}
6767
delete-branch: true
6868
base: ${{ matrix.branch }}

‎.github/workflows/deploy-branch.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,15 @@ jobs:
5252
run: bash setup.sh
5353

5454
# Fetch all remote branches
55-
- name: Fetch remote branch names
55+
- name: Fetch remote branch names
5656
run: git fetch --depth=1 origin +refs/heads/*:refs/remotes/origin/*
57-
57+
5858
# Checkout the gh-pages branch
5959
- name: Checkout gh-pages branch
6060
uses: actions/checkout@v4
6161
with:
6262
ref: gh-pages
63-
63+
6464
# Checkout the branch that the workflow file is running from
6565
- name: Checkout workflow branch
6666
uses: actions/checkout@v4
@@ -75,7 +75,7 @@ jobs:
7575
# Deploy with mike in dry run mode
7676
- name: Deploy SDK (dry run)
7777
if: ${{ github.event.inputs.dry_run == 'true' }}
78-
run: mike deploy "${{ steps.parse_branch.outputs.sdk }}-${{ steps.parse_branch.outputs.version }}"
78+
run: mike deploy "${{ steps.parse_branch.outputs.sdk }}-${{ steps.parse_branch.outputs.version }}"
7979

8080
# Deploy with mike and push
8181
- name: Deploy SDK (push)

‎CONVERSION_MANUAL.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ updatedAt: "Fri Nov 01 2024 17:14:03 GMT+0000 (Coordinated Universal Time)"
3434
---
3535
```
3636

37-
**Action**:
37+
**Action**:
3838
1. **Remove the entire YAML front matter block** (everything between the `---` markers)
3939
2. **Replace with a proper markdown H1 header** using the title from the metadata
4040
3. Ensure only ONE H1 header (`#`) exists per document** - all other sections should use H2 (`##`) or lower
@@ -80,7 +80,7 @@ title: "Player Centric API - Overview"
8080
Content here...
8181

8282
---
83-
title: "Player Centric API - Lifecycle Functions"
83+
title: "Player Centric API - Lifecycle Functions"
8484
---
8585
More content...
8686

@@ -127,7 +127,7 @@ Even more content...
127127
**Before**:
128128
```markdown
129129
> 📘 Compatibility
130-
>
130+
>
131131
> • Beamable supports Unity versions 2021.3 to 2023.3
132132
> • Beamable supports Windows, Mac, iOS, Android platforms
133133
```

‎docs/CONVERSION_MANUAL.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ updatedAt: "Fri Nov 01 2024 17:14:03 GMT+0000 (Coordinated Universal Time)"
3434
---
3535
```
3636

37-
**Action**:
37+
**Action**:
3838
1. **Remove the entire YAML front matter block** (everything between the `---` markers)
3939
2. **Replace with a proper markdown H1 header** using the title from the metadata
4040
3. Ensure only ONE H1 header (`#`) exists per document** - all other sections should use H2 (`##`) or lower
@@ -80,7 +80,7 @@ title: "Player Centric API - Overview"
8080
Content here...
8181

8282
---
83-
title: "Player Centric API - Lifecycle Functions"
83+
title: "Player Centric API - Lifecycle Functions"
8484
---
8585
More content...
8686

@@ -127,7 +127,7 @@ Even more content...
127127
**Before**:
128128
```markdown
129129
> 📘 Compatibility
130-
>
130+
>
131131
> • Beamable supports Unity versions 2021.3 to 2023.3
132132
> • Beamable supports Windows, Mac, iOS, Android platforms
133133
```

‎docs/cli/commands/cli-command-reference/config/config.md‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
2-
1+
2+
33
```shell
44
beam config [options]
5-
```
6-
7-
## About
8-
The config command shows information about the current Beamable connection
9-
strings being used by the Beam CLI. The command will print the CID, PID, HOST, and
10-
current location of the .beamable configuration file.
11-
12-
13-
14-
## Options
15-
16-
|Name|Type|Description|
17-
|-|-|-|
5+
```
6+
7+
## About
8+
The config command shows information about the current Beamable connection
9+
strings being used by the Beam CLI. The command will print the CID, PID, HOST, and
10+
current location of the .beamable configuration file.
11+
12+
13+
14+
## Options
15+
16+
|Name|Type|Description|
17+
|-|-|-|
1818
|--no-overrides|Boolean|Whether this command should ignore the local config overrides|
1919
|--set|Boolean|When true, whatever '--host', '--cid', '--pid' values you provide will be set. If '--no-overrides' is true, this will set the version controlled configuration file. If not, this will set the local overrides file inside the .beamable/temp directory|
2020
|--dryrun|Boolean|[DEPRECATED] Run as much of the command as possible without making any network calls|
@@ -41,14 +41,14 @@ current location of the .beamable configuration file.
4141
|--dotnet-path|String|a custom location for dotnet|
4242
|--version|Boolean|Show version information|
4343
|--help|Boolean|Show help and usage information|
44-
45-
46-
47-
48-
44+
45+
46+
47+
48+
4949
### Sub Commands
5050
- [realm](realm/realm.md)
5151
- [routes](./routes.md)
5252
- [secret](./secret.md)
5353
- [set](./set.md)
54-
54+

‎docs/cli/commands/cli-command-reference/listen/player.md‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,40 @@
1-
2-
1+
2+
33
```shell
44
beam listen player [options]
5-
```
6-
7-
## About
5+
```
6+
7+
## About
88
The listen player command will monitor events sent to the logged in
99
player on the CLI. Player events include updates such as content
10-
notifications, inventory updates, mail updates, and more.
10+
notifications, inventory updates, mail updates, and more.
1111

1212
**IMPORTANT**: The command only works if the realm is configured to use
13-
Beamable Notifications, which is the default setting for new realms
13+
Beamable Notifications, which is the default setting for new realms
1414
as of July 2023. However, if the realm is not using Beamable Notifications,
1515
the following error will be displayed.
1616

1717
```
1818
Only realms with beam notifications are supported. This realm currently has pubnub.
19-
Try setting the realm config to beam with this command,
19+
Try setting the realm config to beam with this command,
2020
""beam config realm set --key-values 'notification|publisher::beamable'""
2121
```
2222

2323
To get started with the command, make sure you have the [CLI configured](../../../../guides/getting-started/),
24-
and an available player.
24+
and an available player.
2525

26-
1. Run `beam me` to get access to the player's `playerId`.
26+
1. Run `beam me` to get access to the player's `playerId`.
2727
2. Use the portal, and navigate to the player's inventory page.
2828
3. Run `beam listen player`, and leave the program running. This starts the listening process.
2929
4. On the portal, change the player's currency value. Alternatively, send the player some mail.
30-
5. On the console, notice the event is received.
31-
32-
33-
34-
## Options
35-
36-
|Name|Type|Description|
37-
|-|-|-|
30+
5. On the console, notice the event is received.
31+
32+
33+
34+
## Options
35+
36+
|Name|Type|Description|
37+
|-|-|-|
3838
|--context|String|A regex to filter for notification channels|
3939
|--dryrun|Boolean|[DEPRECATED] Run as much of the command as possible without making any network calls|
4040
|--cid|String|CID (CustomerId) to use (found in Portal->Account); defaults to whatever is in '.beamable/connection-configuration.json'|
@@ -60,10 +60,10 @@ and an available player.
6060
|--dotnet-path|String|a custom location for dotnet|
6161
|--version|Boolean|Show version information|
6262
|--help|Boolean|Show help and usage information|
63-
64-
65-
66-
### Parent Command
67-
[listen](./listen.md)
68-
69-
63+
64+
65+
66+
### Parent Command
67+
[listen](./listen.md)
68+
69+

‎docs/cli/commands/cli-command-reference/listen/server.md‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
1-
2-
1+
2+
33
```shell
44
beam listen server [options]
5-
```
6-
7-
## About
8-
The listen server command will monitor realm events, such as content publications
5+
```
6+
7+
## About
8+
The listen server command will monitor realm events, such as content publications
99
or changes to realm configuration. Realm events are sent through a websocket
10-
connection, and require admin level privileges.
10+
connection, and require admin level privileges.
1111

1212
This command is meant only as a diagnostic tool, and does not have robust
13-
connection recovery logic.
13+
connection recovery logic.
1414

1515

1616
To get started with the command, make sure you have the [CLI configured](../../../../guides/getting-started/),
1717
and an available player.
1818

19-
1. Run `beam listen server`, and leave the process running.
19+
1. Run `beam listen server`, and leave the process running.
2020
2. Open portal, and navigate to the realm config page. Add a new configuration setting.
21-
3. On the console, notice that the new configuration has been received.
22-
23-
24-
25-
## Options
26-
27-
|Name|Type|Description|
28-
|-|-|-|
21+
3. On the console, notice that the new configuration has been received.
22+
23+
24+
25+
## Options
26+
27+
|Name|Type|Description|
28+
|-|-|-|
2929
|--no-filter|Boolean|When true, do not send any approved list of messages, such that all server messages will be sent|
3030
|--dryrun|Boolean|[DEPRECATED] Run as much of the command as possible without making any network calls|
3131
|--cid|String|CID (CustomerId) to use (found in Portal->Account); defaults to whatever is in '.beamable/connection-configuration.json'|
@@ -51,10 +51,10 @@ and an available player.
5151
|--dotnet-path|String|a custom location for dotnet|
5252
|--version|Boolean|Show version information|
5353
|--help|Boolean|Show help and usage information|
54-
55-
56-
57-
### Parent Command
58-
[listen](./listen.md)
59-
60-
54+
55+
56+
57+
### Parent Command
58+
[listen](./listen.md)
59+
60+

‎docs/cli/commands/cli-command-reference/login.md‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
2-
1+
2+
33
```shell
44
beam login [options]
5-
```
6-
7-
## About
8-
The login command will perform a login action and acquire Beamable authorization tokens. There are two main ways Beamable handles authorization, access tokens, and JWTs. JWTs are still being developed. Access tokens are the primary way to handle authorization. Any API request sent to Beamable needs an `Authorization` header with a bearer token using the Beamable _access token_. These tokens are short lived and will need to be refreshed periodically. The login command also issues a _refresh token_ which can be used to fetch a new _access token_ if the need arises.
9-
10-
By default, the login command will not _save_ your access tokens. You should pass the `--save-to-file` option to commit the _access token_ and _refresh token_ to your `./beamable` folder.
11-
12-
13-
14-
## Options
15-
16-
|Name|Type|Description|
17-
|-|-|-|
5+
```
6+
7+
## About
8+
The login command will perform a login action and acquire Beamable authorization tokens. There are two main ways Beamable handles authorization, access tokens, and JWTs. JWTs are still being developed. Access tokens are the primary way to handle authorization. Any API request sent to Beamable needs an `Authorization` header with a bearer token using the Beamable _access token_. These tokens are short lived and will need to be refreshed periodically. The login command also issues a _refresh token_ which can be used to fetch a new _access token_ if the need arises.
9+
10+
By default, the login command will not _save_ your access tokens. You should pass the `--save-to-file` option to commit the _access token_ and _refresh token_ to your `./beamable` folder.
11+
12+
13+
14+
## Options
15+
16+
|Name|Type|Description|
17+
|-|-|-|
1818
|--email|String|Specify user email address|
1919
|--password|String|User password|
2020
|--save-to-environment|Boolean|Save login refresh token to environment variable|
@@ -46,9 +46,9 @@ By default, the login command will not _save_ your access tokens. You should pas
4646
|--dotnet-path|String|a custom location for dotnet|
4747
|--version|Boolean|Show version information|
4848
|--help|Boolean|Show help and usage information|
49-
50-
51-
52-
53-
54-
49+
50+
51+
52+
53+
54+

0 commit comments

Comments
 (0)