Skip to content

Commit a7a5598

Browse files
authored
docs: Updates & polishes (#1634)
1 parent 1545dfd commit a7a5598

File tree

5 files changed

+47
-32
lines changed

5 files changed

+47
-32
lines changed

apps/docs/cli/cli-reference.mdx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ For more details on building and running workflows, see the [Workflows documenta
4343

4444
## Advanced Concepts
4545

46-
- **Workflows:** Orchestrate complex, multi-step codemod processes. [Learn more ->](#cli-command-reference)
47-
- **jssg:** Run JavaScript/TypeScript codemods using the high-performance ast-grep engine. [See jssg reference ->](#codemod%40next-jssg)
46+
- **Workflows:** Orchestrate complex, multi-step codemod processes.
47+
- **jssg:** Run JavaScript/TypeScript codemods using the high-performance ast-grep engine.
4848

4949
---
5050

@@ -56,7 +56,7 @@ Codemod CLI (new) is accessible using the `npx codemod@next` command. The follow
5656

5757
Manage and execute workflow YAMLs.
5858

59-
**`workflow run`**
59+
#### `workflow run`
6060

6161
Run a workflow.
6262

@@ -70,7 +70,7 @@ npx codemod@next workflow run -w <workflow.yaml|directory> [--param key=value]
7070
Workflow parameters (format: key=value).
7171
</ResponseField>
7272

73-
**`workflow resume`**
73+
#### `workflow resume`
7474

7575
Resume a paused workflow.
7676

@@ -87,7 +87,7 @@ npx codemod@next workflow resume -i <ID> [-t <TASK>] [--trigger-all]
8787
Trigger all awaiting tasks.
8888
</ResponseField>
8989

90-
**`workflow validate`**
90+
#### `workflow validate`
9191

9292
Validate a workflow file.
9393

@@ -124,7 +124,7 @@ npx codemod@next workflow validate -w <workflow.yaml>
124124
- **State consistency**: Whether state updates are logically sound
125125
</Accordion>
126126

127-
**`workflow status`**
127+
#### `workflow status`
128128

129129
Show workflow run status.
130130

@@ -135,7 +135,7 @@ npx codemod@next workflow status -i <ID>
135135
Workflow run ID.
136136
</ResponseField>
137137

138-
**`workflow list`**
138+
#### `workflow list`
139139

140140
List workflow runs.
141141

@@ -146,7 +146,7 @@ npx codemod@next workflow list [-l <LIMIT>]
146146
Number of workflow runs to show. (default: 10)
147147
</ResponseField>
148148

149-
**`workflow cancel`**
149+
#### `workflow cancel`
150150

151151
Cancel a workflow run.
152152

@@ -200,7 +200,7 @@ jssg is a toolkit for running JavaScript/TypeScript codemods using the high-perf
200200
</Step>
201201
</Steps>
202202

203-
**`jssg run`**
203+
#### `jssg run`
204204

205205
Run a jssg codemod.
206206

@@ -232,7 +232,7 @@ npx codemod@next jssg run <codemod_file> <target_directory> [options]
232232
Perform a dry-run to see the changes without applying them.
233233
</ResponseField>
234234

235-
**`jssg test`**
235+
#### `jssg test`
236236

237237
Test a jssg codemod using before/after fixtures.
238238

@@ -500,15 +500,15 @@ npx codemod@next search --format json next
500500

501501
Manage the local package cache for codemod packages.
502502

503-
**`cache info`**
503+
#### `cache info`
504504

505505
Show cache information and statistics.
506506

507507
```bash
508508
npx codemod@next cache info
509509
```
510510

511-
**`cache list`**
511+
#### `cache list`
512512

513513
List cached packages.
514514

@@ -519,7 +519,7 @@ npx codemod@next cache list [--detailed]
519519
Show package details.
520520
</ResponseField>
521521

522-
**`cache clear`**
522+
#### `cache clear`
523523

524524
Clear cache for a specific package, or all packages.
525525

@@ -533,7 +533,7 @@ npx codemod@next cache clear [PACKAGE] [--all]
533533
Clear all cached packages.
534534
</ResponseField>
535535

536-
**`cache prune`**
536+
#### `cache prune`
537537

538538
Prune old or unused cache entries.
539539

apps/docs/cli/workflows.mdx

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Codemod Workflows are self-hostable automations designed for running large-scale
1717
- **Parallel scheduling** — independent nodes run when dependencies allow
1818
- **Host-shell execution** — commands run directly on your machine (container runtimes on the roadmap)
1919

20-
Codemod Workflows can be run using [Codemod CLI](/cli/cli-reference) or [Codemod Platform](/platform/workflows).
20+
Codemod Workflows can be run using [Codemod CLI](/cli/cli-reference) or [Codemod Platform](/migrations).
2121

2222
---
2323

@@ -697,11 +697,8 @@ nodes:
697697

698698
## Next Steps
699699

700-
<CardGroup cols={2}>
700+
<CardGroup cols={1}>
701701
<Card title="Codemod CLI Reference" icon="terminal" href="/cli/cli-reference">
702702
Explore the full command and option reference for Codemod CLI.
703703
</Card>
704-
<Card title="jssg: JavaScript ast-grep" icon="js" href="/cli/jssg">
705-
Perform fast, AST-based searches & transformations using a grep-like interface.
706-
</Card>
707704
</CardGroup>

apps/docs/codemod-studio.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,10 @@ To run codemods, you can:
9292
</Step>
9393
</Steps>
9494

95+
<Info>
96+
Prefer running codemods from your terminal or CI? See our [CLI](/cli/cli-reference) guide for scripting and automating codemods locally or in CI.
97+
</Info>
98+
9599
## Tips for building better codemods
96100

97101
1. **Clarity is Key**: Try to prompt clear requirements when using Codemod AI. Ensure that the transformation logic is clear for both humans and AI. Well-defined logic leads to more accurate codemods.

apps/docs/docs.json

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,7 @@
2020
"groups": [
2121
{
2222
"group": "Quickstart",
23-
"pages": [
24-
"introduction",
25-
"platform/plan",
26-
"platform/automate",
27-
"platform/orchestrate",
28-
"platform/track"
29-
]
23+
"pages": ["introduction"]
3024
},
3125
{
3226
"group": "Codemod Platform",
@@ -38,11 +32,7 @@
3832
},
3933
{
4034
"group": "Quick Links",
41-
"pages": [
42-
"external-links/codemod-platform",
43-
"external-links/codemod-studio",
44-
"external-links/codemod-registry"
45-
]
35+
"pages": ["external-links/codemod-registry"]
4636
},
4737
{
4838
"group": "Other Resources",
@@ -113,6 +103,22 @@
113103
{
114104
"source": "/more-resources/legal/terms-and-conditions",
115105
"destination": "https://codemod.com/terms-and-conditions"
106+
},
107+
{
108+
"source": "/platform/plan",
109+
"destination": "/migrations"
110+
},
111+
{
112+
"source": "/platform/automate",
113+
"destination": "/codemod-studio"
114+
},
115+
{
116+
"source": "/platform/orchestrate",
117+
"destination": "/migrations"
118+
},
119+
{
120+
"source": "/platform/track",
121+
"destination": "/insights"
116122
}
117123
],
118124
"contextual": {

apps/docs/migrations.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,16 @@ Migration Campaigns let engineering teams orchestrate sweeping code changes—fr
99

1010
By combining Codemod’s AI-powered runbooks with deterministic automations, campaigns dramatically lower migration cost and risk while giving you full visibility into progress.
1111

12-
<Tip>
12+
<Info>
1313
Migration Campaigns are designed for [enterprise](https://codemod.com/pricing) engingeering teams. To start a new migration campaign, simply [get in touch with us](https://go.codemod.com/contact) and we'll add the requested migration to your dashboard.
14+
</Info>
15+
16+
## Before you start: plan with Insights
17+
18+
Use **[Codemod Insights](/insights)** dashboards to measure how widespread a pattern is, estimate effort, and decide which repositories to include in your campaign. Once priorities are clear, spin up a new Migration Campaign and execute with confidence.
19+
20+
<Tip>
21+
Not sure where to begin? [Contact us](https://go.codemod.com/contact) and we’ll help surface high-impact, low-effort migrations you can tackle right away.
1422
</Tip>
1523

1624
## Running a Migration Campaign

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy