Skip to content

Commit 88ad859

Browse files
authored
doc: update Quick Start & Architecture in README (#2947)
* doc: TOC, Quick Start, Architecture Overhaul README to improve developer onboarding and documentation. Adds a Table of Contents, Quick Start (TL;DR + detailed Docker, binary, and build-from-source instructions), verification steps, and a Module Map. Expands Features into bullet points and introduces detailed Architecture sections including ASCII and Mermaid diagrams, a deployment comparison table, and module overview. Adds contributor guidance, community/contact info, and ecosystem links. Also updates .serena/project.yml to set project_name and include placeholders for base/default modes, included optional tools, and fixed_tools to enable per-project Serena configuration.
1 parent 9babe49 commit 88ad859

2 files changed

Lines changed: 348 additions & 56 deletions

File tree

.serena/project.yml

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,27 @@ excluded_tools: []
7979
# initial prompt for the project. It will always be given to the LLM upon activating the project
8080
# (contrary to the memories, which are loaded on demand).
8181
initial_prompt: ""
82-
82+
# the name by which the project can be referenced within Serena
8383
project_name: "server"
84+
85+
# list of tools to include that would otherwise be disabled (particularly optional tools that are disabled by default)
8486
included_optional_tools: []
87+
88+
# list of mode names to that are always to be included in the set of active modes
89+
# The full set of modes to be activated is base_modes + default_modes.
90+
# If the setting is undefined, the base_modes from the global configuration (serena_config.yml) apply.
91+
# Otherwise, this setting overrides the global configuration.
92+
# Set this to [] to disable base modes for this project.
93+
# Set this to a list of mode names to always include the respective modes for this project.
94+
base_modes:
95+
96+
# list of mode names that are to be activated by default.
97+
# The full set of modes to be activated is base_modes + default_modes.
98+
# If the setting is undefined, the default_modes from the global configuration (serena_config.yml) apply.
99+
# Otherwise, this overrides the setting from the global configuration (serena_config.yml).
100+
# This setting can, in turn, be overridden by CLI parameters (--mode).
101+
default_modes:
102+
103+
# fixed set of tools to use as the base tool set (if non-empty), replacing Serena's default set of tools.
104+
# This cannot be combined with non-empty excluded_tools or included_optional_tools.
105+
fixed_tools: []

0 commit comments

Comments
 (0)