From 90f50fe638f669651035a0381a49c6f694df0020 Mon Sep 17 00:00:00 2001 From: Dominik Jain Date: Sun, 9 Nov 2025 14:02:02 +0100 Subject: [PATCH] Automate copying of 01-about/000_intro.md to index.md, and ignore index.md --- docs/.gitignore | 1 + docs/create_toc.py | 10 ++++++++++ docs/index.md | 14 -------------- 3 files changed, 11 insertions(+), 14 deletions(-) delete mode 100644 docs/index.md diff --git a/docs/.gitignore b/docs/.gitignore index d86fc2c2..a91099dc 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -2,3 +2,4 @@ /jupyter_execute /conf.py /_build +/index.md diff --git a/docs/create_toc.py b/docs/create_toc.py index 39490e88..8d6867c9 100644 --- a/docs/create_toc.py +++ b/docs/create_toc.py @@ -1,6 +1,16 @@ import os from pathlib import Path +# Copy 01-about/000_intro.md to index.md +# We want the intro to the first chapter to also be the intro to the book, +# and it doesn't seem to be easily possible to get rid of an index file entirely. +directory = Path(__file__).parent +with open(directory / "01-about/000_intro.md", "r", encoding="utf-8") as src: + intro_content = src.read() +with open(directory / "index.md", "w", encoding="utf-8") as dst: + dst.write("\n\n") + dst.write(intro_content) + # This script provides a platform-independent way of making the jupyter-book call (used in pyproject.toml) folder = Path(__file__).parent toc_file = folder / "_toc.yml" diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index a0c18522..00000000 --- a/docs/index.md +++ /dev/null @@ -1,14 +0,0 @@ -# Welcome to Serena! - -* Serena is a powerful **coding agent toolkit** capable of turning an LLM into a fully-featured agent that works - **directly on your codebase**. - Unlike most other tools, it is not tied to an LLM, framework or an interface, making it easy to use it in a variety of ways. -* Serena provides essential **semantic code retrieval and editing tools** that are akin to an IDE's capabilities, - extracting code entities at the symbol level and exploiting relational structure. - When combined with an existing coding agent, these tools greatly enhance (token) efficiency. -* Serena is **free & open-source**, enhancing the capabilities of LLMs you already have access to free of charge. - -Therefore, you can think of Serena as providing IDE-like tools to your LLM/coding agent. -With it, the agent no longer needs to read entire files, perform grep-like searches or string replacements to find and -edit the right code. -Instead, it can use code-centred tools like `find_symbol`, `find_referencing_symbols` and `insert_after_symbol`.