From be6a8f44bd963a52c8375ef849cf7da6e9596732 Mon Sep 17 00:00:00 2001 From: Mike Solomon Date: Mon, 27 Jan 2025 09:03:46 -0800 Subject: [PATCH] Update ide titles/desc --- .../moderne-ide-integration/how-to-guides/code-search.md | 5 +++++ .../how-to-guides/creating-recipes.md | 5 +++++ .../how-to-guides/debugging-recipes.md | 5 +++++ .../how-to-guides/moderne-plugin-install.md | 5 +++++ .../moderne-ide-integration/reference/code-search-actions.md | 5 +++++ .../moderne-ide-integration/reference/refactor-actions.md | 5 +++++ 6 files changed, 30 insertions(+) diff --git a/docs/user-documentation/moderne-ide-integration/how-to-guides/code-search.md b/docs/user-documentation/moderne-ide-integration/how-to-guides/code-search.md index 0e34377d..406bfd5b 100644 --- a/docs/user-documentation/moderne-ide-integration/how-to-guides/code-search.md +++ b/docs/user-documentation/moderne-ide-integration/how-to-guides/code-search.md @@ -1,3 +1,8 @@ +--- +sidebar_label: Multi-repository code search +description: How to search for code across many repositories at once. +--- + # Multi-repository code search Regardless of whether you're a new developer or someone with decades of experience writing code, you will often find yourself wanting to look for examples of how particular pieces of code are used. In fact, about [one third of all Google code searches are attempting to find examples of how others have done something](https://www.oreilly.com/library/view/software-engineering-at/9781492082781/ch17.html#whyquestion_mark). Unfortunately, these searches will often lead to examples that aren't quite right – they might match the same _text_, but they often will not match the _types_. If you attempt to restrict searching to only the repositories on your local machine (such as using `grep` for instance), you will often run into a similar issue. diff --git a/docs/user-documentation/moderne-ide-integration/how-to-guides/creating-recipes.md b/docs/user-documentation/moderne-ide-integration/how-to-guides/creating-recipes.md index 57e6ee51..15e73a99 100644 --- a/docs/user-documentation/moderne-ide-integration/how-to-guides/creating-recipes.md +++ b/docs/user-documentation/moderne-ide-integration/how-to-guides/creating-recipes.md @@ -1,3 +1,8 @@ +--- +sidebar_label: Recipe creation +description: How to create recipes quickly with the Moderne plugin. +--- + # How to create recipes When planning large-scale code changes, it's a good idea to begin by creating a recipe that identifies all of the potential edit sites. Doing so gives you a full impact analysis of what you're about to do, before you actually do it. Taking the time to find all of these locations is especially important because real-world code is complex and nuanced. Without a proper accounting of this nuance, writing a _transformation_ recipe will not be as accurate as you'd wish. diff --git a/docs/user-documentation/moderne-ide-integration/how-to-guides/debugging-recipes.md b/docs/user-documentation/moderne-ide-integration/how-to-guides/debugging-recipes.md index e26302d5..254e4d3e 100644 --- a/docs/user-documentation/moderne-ide-integration/how-to-guides/debugging-recipes.md +++ b/docs/user-documentation/moderne-ide-integration/how-to-guides/debugging-recipes.md @@ -1,3 +1,8 @@ +--- +sidebar_label: Debugging recipes +description: How to debug a recipe using the Moderne plugin. +--- + # How to debug a recipe using the Moderne plugin One key benefit of the Moderne IDE plugin is the ability to quickly debug recipes against real code. You can set breakpoints in your IDE and have those be hit when you run a recipe in the Moderne CLI – so you can know exactly what is happening in the recipe. diff --git a/docs/user-documentation/moderne-ide-integration/how-to-guides/moderne-plugin-install.md b/docs/user-documentation/moderne-ide-integration/how-to-guides/moderne-plugin-install.md index 70e4dcad..55a88103 100644 --- a/docs/user-documentation/moderne-ide-integration/how-to-guides/moderne-plugin-install.md +++ b/docs/user-documentation/moderne-ide-integration/how-to-guides/moderne-plugin-install.md @@ -1,3 +1,8 @@ +--- +sidebar_label: Installation and configuration +description: How to install and configure the Moderne plugin. +--- + import ReactPlayer from 'react-player'; # How to install and configure the Moderne plugin diff --git a/docs/user-documentation/moderne-ide-integration/reference/code-search-actions.md b/docs/user-documentation/moderne-ide-integration/reference/code-search-actions.md index aecd6960..9854dded 100644 --- a/docs/user-documentation/moderne-ide-integration/reference/code-search-actions.md +++ b/docs/user-documentation/moderne-ide-integration/reference/code-search-actions.md @@ -1,3 +1,8 @@ +--- +sidebar_label: Code search actions +description: Code search action reference documentation. To be created at a later time. +--- + # Code search actions TODO this is a placeholder for reference documentation on every code search action available in the IDE. diff --git a/docs/user-documentation/moderne-ide-integration/reference/refactor-actions.md b/docs/user-documentation/moderne-ide-integration/reference/refactor-actions.md index 3a3b0133..30d3ba37 100644 --- a/docs/user-documentation/moderne-ide-integration/reference/refactor-actions.md +++ b/docs/user-documentation/moderne-ide-integration/reference/refactor-actions.md @@ -1,3 +1,8 @@ +--- +sidebar_label: Refactor actions +description: Refactor action reference documentation. To be created at a later time. +--- + # Refactor actions TODO this is a placeholder for reference documentation on every refactor action available in the IDE.