diff --git a/docs/02-usage/040_workflow.md b/docs/02-usage/040_workflow.md index ce8fbb77..219d33c2 100644 --- a/docs/02-usage/040_workflow.md +++ b/docs/02-usage/040_workflow.md @@ -18,20 +18,22 @@ setting up a project with Serena typically involves the following steps: Project creation is the process of defining fundamental project settings that are relevant to Serena's operation. You can create a project either + * explicitly, using the project creation command (see below), or * implicitly, by just activating a directory as a project while already in a conversation; this will use default settings for your project (skip to the next section). - * explicitly, using the project creation command, or ### Explicit Project Creation To explicitly create a project, use the following command while in the project directory: - serena project create [options] + serena project create [options] [project directory] - * For an empty project, you will need to specify the programming language - (e.g., `--language python`). - * For an existing project, the main programming language will be detected automatically, - but you can choose to explicitly specify multiple languages by passing the `--language` parameter - multiple times (e.g. `--language python --language typescript`). + * The project directory defaults to the current directory if not specified. + * For an existing project, the programming languages will be detected based on + the source files present, and the main language will be activated automatically. + If multiple languages are detected, you will be prompted whether you want to enable them. + * For an empty project, you can optionally specify one or more languages + to be activated explicitly via the `--language` parameter + (e.g. `--language python --language typescript`). * You can optionally specify a custom project name with `--name my-name`. * You can immediately index the project after creation with `--index`. @@ -42,6 +44,7 @@ After creation, you can adjust the project settings in the generated `.serena/pr within the project directory. The file allows you to configure ... + * the name by which you want to refer to the project (relevant when telling the LLM to dynamically activate the project) * the set of programming languages for which language servers are spawned (not relevant when using the JetBrains plugin) Note that you can dynamically add/remove language servers while Serena is running via the [Dashboard](060_dashboard). * the [language backend](per-project-language-backend) to use for this project (overriding the global setting) @@ -49,8 +52,8 @@ The file allows you to configure ... * ignore rules * write access * an initial prompt that shall be passed to the LLM whenever the project is activated - * the name by which you want to refer to the project (relevant when telling the LLM to dynamically activate the project) - * the set of tools and modes to use by default + * the set of tools and modes to use for the project + * and some other settings. For detailed information on the parameters and possible settings, see the [template file](https://github.com/oraios/serena/blob/main/src/serena/resources/project.template.yml).