diff --git a/apps/docs/codemod-registry/introduction.mdx b/apps/docs/codemod-registry/introduction.mdx index 5bced1525..782da031c 100644 --- a/apps/docs/codemod-registry/introduction.mdx +++ b/apps/docs/codemod-registry/introduction.mdx @@ -1,6 +1,5 @@ --- title: 'Codemod Regisry' -icon: 'share-nodes' --- [Codemod Registry](https://codemod.com/registry) is a centralized hub for discovering and sharing codemods, making them easily accessible to open-source communities and teams of any size. diff --git a/apps/docs/docs.json b/apps/docs/docs.json index fe6c23031..ea37fe747 100644 --- a/apps/docs/docs.json +++ b/apps/docs/docs.json @@ -22,21 +22,18 @@ "group": "Quickstart", "pages": [ "introduction", - "platform/build", - "platform/share", - "platform/run" + "platform/plan", + "platform/automate", + "platform/orchestrate", + "platform/track" ] }, { "group": "Codemod Platform", - "pages": [ - "scanner", - "codemod-studio", - "codemod-registry/introduction" - ] + "pages": ["scanner", "migrations", "insights", "codemod-studio"] }, { - "group": "Legacy Guides", + "group": "OSS & Community", "pages": [ { "group": "Building codemods", @@ -53,7 +50,10 @@ }, { "group": "Sharing codemods", - "pages": ["sharing/publishing-codemods"] + "pages": [ + "codemod-registry/introduction", + "sharing/publishing-codemods" + ] } ] }, diff --git a/apps/docs/images/campaigns/campaigns.mp4 b/apps/docs/images/campaigns/campaigns.mp4 new file mode 100644 index 000000000..d729c965d Binary files /dev/null and b/apps/docs/images/campaigns/campaigns.mp4 differ diff --git a/apps/docs/images/campaigns/migrations.png b/apps/docs/images/campaigns/migrations.png new file mode 100644 index 000000000..d54b06bca Binary files /dev/null and b/apps/docs/images/campaigns/migrations.png differ diff --git a/apps/docs/images/campaigns/running-migration.mp4 b/apps/docs/images/campaigns/running-migration.mp4 new file mode 100644 index 000000000..0dd76c0d6 Binary files /dev/null and b/apps/docs/images/campaigns/running-migration.mp4 differ diff --git a/apps/docs/images/insights/create-dashboard.png b/apps/docs/images/insights/create-dashboard.png new file mode 100644 index 000000000..e2dd8db82 Binary files /dev/null and b/apps/docs/images/insights/create-dashboard.png differ diff --git a/apps/docs/images/insights/create-widget.png b/apps/docs/images/insights/create-widget.png new file mode 100644 index 000000000..dbe0b8aad Binary files /dev/null and b/apps/docs/images/insights/create-widget.png differ diff --git a/apps/docs/images/insights/insights-demo.mp4 b/apps/docs/images/insights/insights-demo.mp4 new file mode 100644 index 000000000..9e30de7b0 Binary files /dev/null and b/apps/docs/images/insights/insights-demo.mp4 differ diff --git a/apps/docs/images/insights/query-formula.png b/apps/docs/images/insights/query-formula.png new file mode 100644 index 000000000..b0ef36ba4 Binary files /dev/null and b/apps/docs/images/insights/query-formula.png differ diff --git a/apps/docs/images/insights/setting-up-widget.mp4 b/apps/docs/images/insights/setting-up-widget.mp4 new file mode 100644 index 000000000..af5a5593c Binary files /dev/null and b/apps/docs/images/insights/setting-up-widget.mp4 differ diff --git a/apps/docs/insights.mdx b/apps/docs/insights.mdx new file mode 100644 index 000000000..bda417279 --- /dev/null +++ b/apps/docs/insights.mdx @@ -0,0 +1,79 @@ +--- +title: 'Insights' +icon: 'chart-simple' +--- + +In large codebases, tracking migrations, old/new APIs, security anti-patterns, and trends can be incredibly useful. Engineers and engineering leaders in progressive software teams can stay on top of these changes using **Codemod Insights**. + +With Codemod Insights, you can generate customized dashboards and widgets that provide helpful insights about your code's posture. This way, you can make informed decisions and track code changes that scale over time. + + + + + + +## Using Codemod Insights + + + + Dashboards help you keep your insights' widgets organized. + + For example, you can create a dashboard called `i18n migration` to organize all widgets related to your i18n migration. + + To create a new dashboard, go to `Insights -> Create Dashboard`. + + + ![Creating a new dashboard](/images/insights/create-dashboard.png) + + + + Once you're in your new dashboard, you can create a new widget. + + Widgets help you get useful insights about a variety of patterns in your codebase. + + Currently, you can create `Timeseries chart`, `Single number`, or `Table` widgets. + + + ![Creating a new widget](/images/insights/create-widget.png) + + + + Widgets allow you to track and visualize insights by running queries over your codebase. Each query represents an [`ast-grep` YAML rule](https://ast-grep.github.io/reference/yaml.html) that is applied to your repository. + + Start by specifying a code pattern you would like to track and visualize. You can generate ast-grep rules with the help of AI [using Codemod Studio](/codemod-studio#using-codemod-ai). + + For each quer, you can specify: + - `ast-grep` rule ([generate rules easily with codemod studio](/codemod-studio#using-codemod-ai)) + - match type, can be occurrence counts or file counts + - target repository + - query label + - group options + - date/commit hash (for Single number and Table widgets) + + + + + + + When configuring widgets, you can add multiple queries to extend the information a widget provides. Additionally, you can aggregate the results of multiple queries by specifying a formula. To refer to a query's value in a formula, use the query's name (alphabetical order index). + + + ![Writing formulas](/images/insights/query-formula.png) + + + + \ No newline at end of file diff --git a/apps/docs/introduction.mdx b/apps/docs/introduction.mdx index 975f4e989..0ce4a10fb 100644 --- a/apps/docs/introduction.mdx +++ b/apps/docs/introduction.mdx @@ -1,12 +1,19 @@ --- title: Overview -description: 'Build, share, and run codemods faster and easier.' --- -Codemod platform architecture + + Codemod platform architecture + Codemod platform architecture + Codemod platform helps you create, distribute, and run codemods in codebases of any size. @@ -19,16 +26,16 @@ We are making dream migrations a reality for all developers in the world, one fr Take the first step towards modernizing your codebase. - + Build your own codemods, with the help of AI. - - Share your codemods with the world. + + Put migrations, code search, and insights on autopilot. - - Run your or community-made codemods over your projects. + + Orchestrate & manage large-scale code migration campaigns. - - Manage large-scale code migrations across many teams. + + This helps you stay on top of code changes that scale over time. diff --git a/apps/docs/migrations.mdx b/apps/docs/migrations.mdx index 33a7d9f90..0af9b4ea5 100644 --- a/apps/docs/migrations.mdx +++ b/apps/docs/migrations.mdx @@ -2,3 +2,30 @@ title: 'Migrations' icon: 'arrow-up-right-dots' --- + +Migration campaigns allow progressive software teams to orchestrate large-scale and incremental code migrations. + +By using Codemod during migrations, you get access to runbooks, automations, and a developer experience that drastically increases migration success potential and reduces the spent migration effort & time. + + + ![Migrations dashboard](/images/campaigns/migrations.png) + + + + Migration Campaigns is a feature designed for enterprise 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. + + +## Starting migration campaigns + +Codemod's free-tier allows you to test internationalization (i18n) campaigns. To use Codemod for other migrations and/or get access to the [pro tier](https://codemod.com/pricing), please [contact us](https://go.codemod.com/contact). + + + + \ No newline at end of file diff --git a/apps/docs/platform/automate.mdx b/apps/docs/platform/automate.mdx new file mode 100644 index 000000000..16889ba37 --- /dev/null +++ b/apps/docs/platform/automate.mdx @@ -0,0 +1,15 @@ +--- +title: Automate Migrations +sidebarTitle: "Automate" +--- + +Codemod platform provides a developer experience that significantly reduces the friction of automating code migrations. + +With Codemod platform, you can put code migrations on autopilot with AI-powered [ast-grep](https://ast-grep.github.io/) rules. + +## Start automating migrations + + Get started with building codemods using Codemod Studio. + + +The [legacy jscodeshift studio](https://codemod.com/studio-jscodeshift) has been deprecated in favor of our new [Codemod Studio powered by ast-grep](https://go.codemod.com/studio). If you would like to build legacy jscodeshift codemods, please refer to the [building legacy codemods docs](/building-codemods/package-requirements). \ No newline at end of file diff --git a/apps/docs/platform/orchestrate.mdx b/apps/docs/platform/orchestrate.mdx new file mode 100644 index 000000000..c49681a89 --- /dev/null +++ b/apps/docs/platform/orchestrate.mdx @@ -0,0 +1,15 @@ +--- +title: Orchestrate Migrations +sidebarTitle: "Orchestrate" +--- + +Code migrations are often an incremental process that grows in complexity over time. By using Migration Campaigns, Codemod provides the required tooling to help teams navigate large-scale migration complexities. + +## Start automating migrations + + Orchestrate large-scale migration campaigns. + diff --git a/apps/docs/platform/plan.mdx b/apps/docs/platform/plan.mdx new file mode 100644 index 000000000..be4d93522 --- /dev/null +++ b/apps/docs/platform/plan.mdx @@ -0,0 +1,28 @@ +--- +title: Plan Migrations +sidebarTitle: "Plan" +--- + +Codemod allows you to confidently plan and execute large-scale code migrations by providing essential tooling to: + 1. [Identify migration opportunities](/scanner): Discover areas such as dependency upgrades, security patches, internationalization migrations, and more. + 2. [Gain actionable insights into your codebase's state](/insights): Enable engineers and technical leaders to make informed decisions and continuously plan future migrations. + + +## Get started with migration planning + + + + Uncover and measure high-impact migration opportunities. + + + Get helpful insights to confidently find & plan future migrations. + + \ No newline at end of file diff --git a/apps/docs/platform/share.mdx b/apps/docs/platform/share.mdx index 8b7c46b2d..d992757b4 100644 --- a/apps/docs/platform/share.mdx +++ b/apps/docs/platform/share.mdx @@ -1,6 +1,6 @@ --- title: Sharing Codemods -sidebarTitle: "Share" +sidebarTitle: "Distribute" --- To streamline distributing and collaborating on your codemods, Codemod platform allows you to easily share codemods with friends, team members, the open-source community. diff --git a/apps/docs/platform/track.mdx b/apps/docs/platform/track.mdx new file mode 100644 index 000000000..6a5c450cc --- /dev/null +++ b/apps/docs/platform/track.mdx @@ -0,0 +1,15 @@ +--- +title: Track Migrations & Code Posture +sidebarTitle: "Track" +--- + +Codemod allows you to continuously track and get detailed insights about your code posture. This helps you stay on top of code migrations, security posture, unwanted code patterns and more changes that scale over time. + +## Start automating migrations + + Get helpful insights to confidently find & plan future migrations. + diff --git a/apps/docs/scanner.mdx b/apps/docs/scanner.mdx index d7e8d136f..b8bf143e2 100644 --- a/apps/docs/scanner.mdx +++ b/apps/docs/scanner.mdx @@ -1,5 +1,5 @@ --- -title: 'Migration Scanner' +title: 'Opportunity Finder' icon: 'magnifying-glass' ---