Skip to content

Commit 34a703a

Browse files
committed
Restore links to quick start guide, updating the docs autogen build script
1 parent 38699a8 commit 34a703a

2 files changed

Lines changed: 10 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ Practically, this means that your agent operates **faster, more efficiently and
1818
more complex codebases.
1919

2020
> [!IMPORTANT]
21-
> Don't install Serena via an MCP or plugin marketplace! They contain outdated and suboptimal installation commands. Instead, follow our Quick Start instructions.
21+
> Do not install Serena via an MCP or plugin marketplace! They contain outdated and suboptimal installation commands.
22+
> Instead, follow our [Quick Start](quick-start) instructions.
2223
2324
## How Serena Works
2425

@@ -37,7 +38,7 @@ To connect the Serena MCP server to your client, you either
3738
* provide the client with a launch command that allows it to start the MCP server, or
3839
* start the Serena MCP server yourself in HTTP mode and provide the client with the URL.
3940

40-
See the Quick Start section below for information on how to get started.
41+
See the [Quick Start](quick-start) section below for information on how to get started.
4142

4243
## Programming Language Support & Semantic Analysis Capabilities
4344

docs/autogen_docs.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,8 +194,14 @@ def autogen_about_intro_features():
194194
f.write(autogen_info)
195195
f.write("# About Serena\n\n")
196196
f.write(f"**{tagline}**\n\n")
197+
198+
# adjust link
197199
about_text = about_text.replace("resources/serena-block-diagram.svg", "https://raw.githubusercontent.com/oraios/serena/main/resources/serena-block-diagram.svg")
198-
about_text = re.subn(r"^See the \[Quick Start.*?$", r"", about_text, flags=re.MULTILINE)[0]
200+
201+
# remove statements with links that are invalid and the callout
202+
about_text = re.subn(r"^.*\[Quick Start.*?$", r"", about_text, flags=re.MULTILINE)[0]
203+
about_text = re.subn(r"^>.*?$", "", about_text, flags=re.MULTILINE)[0]
204+
199205
f.write(f"{about_text}\n\n")
200206

201207
jetbrains_marketplace_link = ('```{raw} html\n'

0 commit comments

Comments
 (0)