From 7586514abf700ce9b3336a5f6096955e7a0863e1 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Sun, 15 Sep 2024 08:28:01 +0300 Subject: [PATCH] docs: clarify guidelines on file length and specificity in improve.md --- docs/docs/tools/improve.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/docs/tools/improve.md b/docs/docs/tools/improve.md index f5a8da1d..fb8d442e 100644 --- a/docs/docs/tools/improve.md +++ b/docs/docs/tools/improve.md @@ -128,7 +128,9 @@ This file is only an example. Since it is used as a prompt for an AI model, we w - It should be written in a clear and concise manner - If needed, it should give short relevant code snippets as examples -- Up to 800 lines are allowed +- No more than 800 lines of text are allowed. Why: + - Very long best practices file may not be fully processed by the AI model. + - A very long file may represent a more "**generic**" set of guidelines, similar to what the AI model was already trained on. The goal here is to distill a more specific set of guidelines, that are relevant to the specific needs of the project. Example results: