From 85db0d42ee6ee3b90fc99c47ccab43af3e0df584 Mon Sep 17 00:00:00 2001 From: Michael Panchenko Date: Sat, 31 May 2025 12:34:49 +0200 Subject: [PATCH] Docs, minor [ci skip] --- README.md | 6 +++++- lessons_learned.md | 8 ++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d7b589c..61e7607 100644 --- a/README.md +++ b/README.md @@ -180,7 +180,11 @@ Serena can be used in various ways, below you will find instructions for selecte ``` You can now add Serena to your MCP client as described below for various clients and -[activate your first project]() +[activate your first project](#project-activation). + +> In the default configuration, Serena will start a small dashboard on localhost that will display logs and allow shutting down the +> MCP server (since many clients fail to cleanup processes, leaving zombies behind). If you don't want that, simply set `web_dashboard` to `False` +> in your `serena_config.yml`. ### Configuration diff --git a/lessons_learned.md b/lessons_learned.md index 765b187..d05b5cf 100644 --- a/lessons_learned.md +++ b/lessons_learned.md @@ -13,6 +13,14 @@ useful for small projects to get going fast, it is not wise for more serious pro all tools are defined independently and then converted to instances of `MCPTool` using our `make_tool` function. +### Autogenerated PromptFactory + +Prompt templates are central for most LLM applications, so one needs good representations of them in the code, +while at the same time they often need to be customizable and exposed to users. In Serena we address these conflicting +needs by defining prompt templates (in jinja format) in separate yamls that users can easily modify and by autogenerated +a `PromptFactory` class with meaningful method and parameter names from these yamls. The latter is committed to our code. +We separated out the generation logic into the [interprompt](/src/interprompt/README.md) subpackage that can be used as a library. + ### Tempfiles and Snapshots for Testing of Editing Tools We test most aspects of Serena by having a small "project" for each supported language in `tests/resources`.