Skip to content

Commit 6a74d76

Browse files
authored
docs: shrink width of generated docs (#899)
1 parent 4e0ebb9 commit 6a74d76

File tree

11 files changed

+844
-886
lines changed

11 files changed

+844
-886
lines changed

docs/reference.md

Lines changed: 316 additions & 161 deletions
Large diffs are not rendered by default.

scripts/generate-cli-docs.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import type { CommandsInCategory } from './documentation-renderer/doc-building.j
33
import { renderDocs } from './documentation-renderer/doc-building.js';
44

55
// This sets the maximum line length that will be rendered in the docs.
6-
process.env.APIFY_CLI_MAX_LINE_WIDTH = '150';
6+
process.env.APIFY_CLI_MAX_LINE_WIDTH = '80';
77

88
const categories: Record<string, CommandsInCategory[]> = {
99
'auth': [

src/commands/create.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,7 @@ export class CreateCommand extends ApifyCommand<typeof CreateCommand> {
4040
static override flags = {
4141
template: Flags.string({
4242
char: 't',
43-
description:
44-
'Template for the Actor. If not provided, the command will prompt for it.\n' +
45-
`Visit ${manifestUrl} to find available template names.`,
43+
description: `Template for the Actor. If not provided, the command will prompt for it. Visit ${manifestUrl} to find available template names.`,
4644
required: false,
4745
}),
4846
'skip-dependency-install': Flags.boolean({

src/commands/login.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,12 @@ export class LoginCommand extends ApifyCommand<typeof LoginCommand> {
5656
static override flags = {
5757
token: Flags.string({
5858
char: 't',
59-
description: '[Optional] Apify API token',
59+
description: 'Apify API token',
6060
required: false,
6161
}),
6262
method: Flags.string({
6363
char: 'm',
64-
description: '[Optional] Method of logging in to Apify',
64+
description: 'Method of logging in to Apify',
6565
choices: ['console', 'manual'],
6666
required: false,
6767
}),

src/commands/secrets/_index.ts

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,14 @@ export class SecretsIndexCommand extends ApifyCommand<typeof SecretsIndexCommand
1010
`Manages secure environment variables for Actors.\n\n` +
1111
`Example:\n` +
1212
`$ apify secrets add mySecret TopSecretValue123\n\n` +
13-
`The "mySecret" value can be used in an environment variable defined in '${LOCAL_CONFIG_PATH}' file by adding the "@"\n` +
14-
`prefix:\n\n` +
13+
`The "mySecret" value can be used in an environment variable defined in '${LOCAL_CONFIG_PATH}' file by adding the "@" prefix:\n\n` +
1514
`{\n` +
1615
` "actorSpecification": 1,\n` +
1716
` "name": "my_actor",\n` +
1817
` "environmentVariables": { "SECRET_ENV_VAR": "@mySecret" },\n` +
1918
` "version": "0.1"\n` +
2019
`}\n\n` +
21-
`When the Actor is pushed to Apify cloud, the "SECRET_ENV_VAR" and its value is stored as a secret environment variable\n` +
22-
`of the Actor.`;
20+
`When the Actor is pushed to Apify cloud, the "SECRET_ENV_VAR" and its value is stored as a secret environment variable of the Actor.`;
2321

2422
static override subcommands = [SecretsAddCommand, SecretsRmCommand];
2523

src/commands/validate-schema.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ export class ValidateInputSchemaCommand extends ApifyCommand<typeof ValidateInpu
1313
static override name = 'validate-schema' as const;
1414

1515
static override description = `Validates Actor input schema from one of these locations (in priority order):
16-
1. Object in '${LOCAL_CONFIG_PATH}' under "input" key
17-
2. JSON file path in '${LOCAL_CONFIG_PATH}' "input" key
18-
3. .actor/INPUT_SCHEMA.json
19-
4. INPUT_SCHEMA.json
16+
1. Object in '${LOCAL_CONFIG_PATH}' under "input" key
17+
2. JSON file path in '${LOCAL_CONFIG_PATH}' "input" key
18+
3. .actor/INPUT_SCHEMA.json
19+
4. INPUT_SCHEMA.json
2020
21-
Optionally specify custom schema path to validate.`;
21+
Optionally specify custom schema path to validate.`;
2222

2323
static override args = {
2424
path: Args.string({

src/lib/command-framework/help/CommandHelp.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ export class CommandHelp extends BaseCommandRenderer {
271271
linesOfFlags.set(stringParts.join(' '), flag);
272272
}
273273

274-
const widestFlagNameLength = widestLine([...linesOfFlags.keys()].join('\n'));
274+
const widestFlagNameLength = widestLine([...linesOfFlags.keys()].map(stripAnsi).join('\n'));
275275

276276
for (const [flagString, flag] of linesOfFlags) {
277277
const paddingToAdd = widestFlagNameLength - stripAnsi(flagString).length;

website/versioned_docs/version-0.20/changelog.md

Lines changed: 52 additions & 274 deletions
Large diffs are not rendered by default.

website/versioned_docs/version-0.21/changelog.md

Lines changed: 52 additions & 274 deletions
Large diffs are not rendered by default.
Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
---
2+
title: Changelog
3+
sidebar_label: Changelog
4+
toc_max_heading_level: 3
5+
---
6+
7+
### [1.1.2-beta.0](https://github.com/apify/apify-cli/releases/tag/v1.1.2-beta.0)
8+
9+
### [1.1.1](https://github.com/apify/apify-cli/releases/tag/v1.1.1)
10+
11+
##### [1.1.1](https://github.com/apify/apify-cli/releases/tag/v1.1.1) (2025-08-18)
12+
13+
###### 🐛 Bug Fixes
14+
15+
- Unknown errors from tracking ([#895](https://github.com/apify/apify-cli/pull/895)) ([3485f36](https://github.com/apify/apify-cli/commit/3485f366f3a62117ac833e78157c230206c3c60e)) by [@vladfrangu](https://github.com/vladfrangu)
16+
- Upgrade command should always check when manually ran ([#897](https://github.com/apify/apify-cli/pull/897)) ([5e0ea9f](https://github.com/apify/apify-cli/commit/5e0ea9ff84012732ca7117d1f68207b5170ffeed)) by [@vladfrangu](https://github.com/vladfrangu)
17+
18+
### [1.1.1-beta.3](https://github.com/apify/apify-cli/releases/tag/v1.1.1-beta.3)
19+
20+
### [1.1.1-beta.2](https://github.com/apify/apify-cli/releases/tag/v1.1.1-beta.2)
21+
22+
### [1.1.1-beta.1](https://github.com/apify/apify-cli/releases/tag/v1.1.1-beta.1)
23+
24+
### [1.1.1-beta.0](https://github.com/apify/apify-cli/releases/tag/v1.1.1-beta.0)
25+
26+
### [1.1.0](https://github.com/apify/apify-cli/releases/tag/v1.1.0)
27+
28+
##### [1.1.0](https://github.com/apify/apify-cli/releases/tag/v1.1.0) (2025-08-13)
29+
30+
###### 🚀 Features
31+
32+
- Upgrade command, install shell script ([#810](https://github.com/apify/apify-cli/pull/810)) ([51ef00a](https://github.com/apify/apify-cli/commit/51ef00ad32a6835c48781b99c6233113cf58d8a4)) by [@vladfrangu](https://github.com/vladfrangu)
33+
- \[**breaking**] Make storage purging default, add `--resurrect` ([#729](https://github.com/apify/apify-cli/pull/729)) ([8dff93a](https://github.com/apify/apify-cli/commit/8dff93a2d769997a96d4a7750fb36c2770b9a61c)) by [@vladfrangu](https://github.com/vladfrangu)
34+
- Handle sub-schema validation ([#853](https://github.com/apify/apify-cli/pull/853)) ([5fc2a2f](https://github.com/apify/apify-cli/commit/5fc2a2f6b780a86a250b69375455f3bb2e9a8983)) by [@MFori](https://github.com/MFori)
35+
- Upgrade command upgrading CLI + install command ([#856](https://github.com/apify/apify-cli/pull/856)) ([4252e6c](https://github.com/apify/apify-cli/commit/4252e6cb681deb5f92c654520d0ed03b70e426c3)) by [@vladfrangu](https://github.com/vladfrangu)
36+
- Add signature to KV store URLs where required ([#875](https://github.com/apify/apify-cli/pull/875)) ([a1e9982](https://github.com/apify/apify-cli/commit/a1e998270b5c05cd91280efa144325e2d7a7de0e)) by [@danpoletaev](https://github.com/danpoletaev)
37+
38+
###### 🐛 Bug Fixes
39+
40+
- Pretty message for invalid choices ([#805](https://github.com/apify/apify-cli/pull/805)) ([57bd5de](https://github.com/apify/apify-cli/commit/57bd5de9bc5289f151a9083533dc3d2c71f8b9ab)) by [@vladfrangu](https://github.com/vladfrangu)
41+
- Shebangs ([#806](https://github.com/apify/apify-cli/pull/806)) ([1cdc101](https://github.com/apify/apify-cli/commit/1cdc1011f36974708ab91a25d4d6c6a5dc43d989)) by [@vladfrangu](https://github.com/vladfrangu)
42+
- Recognize sh files as text files ([#813](https://github.com/apify/apify-cli/pull/813)) ([ef3e9b0](https://github.com/apify/apify-cli/commit/ef3e9b064483c04cd7bef2143a19e1a6992ddcff)) by [@DaveHanns](https://github.com/DaveHanns)
43+
- **init:** Prompt for a name if an old config does not exist ([#836](https://github.com/apify/apify-cli/pull/836)) ([26fcd66](https://github.com/apify/apify-cli/commit/26fcd660a0f7b4adb4e1a3329705a8ff6d8f43b2)) by [@vladfrangu](https://github.com/vladfrangu)
44+
- Pass apify client down to output job log wherever possible ([#839](https://github.com/apify/apify-cli/pull/839)) ([5cdb06c](https://github.com/apify/apify-cli/commit/5cdb06c0e24c2501b2034dbb7339798985b269cc)) by [@vladfrangu](https://github.com/vladfrangu)
45+
- **pull:** Handle private actors correctly ([#865](https://github.com/apify/apify-cli/pull/865)) ([efd7308](https://github.com/apify/apify-cli/commit/efd730855f99a36091ce51d501e5755b5ad79ffb)) by [@vladfrangu](https://github.com/vladfrangu)
46+
47+
###### Chore
48+
49+
- \[**breaking**] Move from yargs to node:util ([#871](https://github.com/apify/apify-cli/pull/871)) ([482d0b2](https://github.com/apify/apify-cli/commit/482d0b29f285c020320f1f2e3f0fd08a362d57cc)) by [@vladfrangu](https://github.com/vladfrangu)
50+
- \[**breaking**] Make opening the actor build results in push opt-in ([#881](https://github.com/apify/apify-cli/pull/881)) ([d842424](https://github.com/apify/apify-cli/commit/d84242421387a9487eef5c07183dd0b8ac7ae67b)) by [@vladfrangu](https://github.com/vladfrangu)
51+
52+
### [0.21.10-beta.25](https://github.com/apify/apify-cli/releases/tag/v0.21.10-beta.25)
53+
54+
### [0.21.10-beta.24](https://github.com/apify/apify-cli/releases/tag/v0.21.10-beta.24)
55+
56+
### [0.21.10-beta.23](https://github.com/apify/apify-cli/releases/tag/v0.21.10-beta.23)
57+
58+
### [0.21.10-beta.22](https://github.com/apify/apify-cli/releases/tag/v0.21.10-beta.22)
59+
60+
### [0.21.10-beta.21](https://github.com/apify/apify-cli/releases/tag/v0.21.10-beta.21)
61+
62+
### [0.21.10-beta.20](https://github.com/apify/apify-cli/releases/tag/v0.21.10-beta.20)
63+
64+
### [0.21.10-beta.19](https://github.com/apify/apify-cli/releases/tag/v0.21.10-beta.19)
65+
66+
### [0.21.10-beta.18](https://github.com/apify/apify-cli/releases/tag/v0.21.10-beta.18)
67+
68+
### [0.21.10-beta.17](https://github.com/apify/apify-cli/releases/tag/v0.21.10-beta.17)
69+
70+
### [0.21.10-beta.16](https://github.com/apify/apify-cli/releases/tag/v0.21.10-beta.16)
71+
72+
### [0.21.10-beta.15](https://github.com/apify/apify-cli/releases/tag/v0.21.10-beta.15)
73+
74+
### [0.21.10-beta.14](https://github.com/apify/apify-cli/releases/tag/v0.21.10-beta.14)
75+
76+
### [0.21.10-beta.13](https://github.com/apify/apify-cli/releases/tag/v0.21.10-beta.13)
77+
78+
### [0.21.10-beta.12](https://github.com/apify/apify-cli/releases/tag/v0.21.10-beta.12)
79+
80+
### [0.21.10-beta.11](https://github.com/apify/apify-cli/releases/tag/v0.21.10-beta.11)
81+
82+
### [0.21.10-beta.9](https://github.com/apify/apify-cli/releases/tag/v0.21.10-beta.9)
83+
84+
### [0.21.10-beta.10](https://github.com/apify/apify-cli/releases/tag/v0.21.10-beta.10)
85+
86+
### [0.21.10-beta.8](https://github.com/apify/apify-cli/releases/tag/v0.21.10-beta.8)
87+
88+
### [0.21.10-beta.7](https://github.com/apify/apify-cli/releases/tag/v0.21.10-beta.7)
89+
90+
### [0.21.10-beta.6](https://github.com/apify/apify-cli/releases/tag/v0.21.10-beta.6)
91+
92+
### [0.21.10-beta.5](https://github.com/apify/apify-cli/releases/tag/v0.21.10-beta.5)
93+
94+
### [0.21.10-beta.4](https://github.com/apify/apify-cli/releases/tag/v0.21.10-beta.4)
95+
96+
### [0.21.10-beta.3](https://github.com/apify/apify-cli/releases/tag/v0.21.10-beta.3)

0 commit comments

Comments
 (0)