From 768ce05dee3b24d89a0c6153d2ec96cada7d52a6 Mon Sep 17 00:00:00 2001 From: Sebastian Mendel Date: Fri, 14 Aug 2026 14:42:57 +0200 Subject: [PATCH] [TASK] Warn against symlinks inside the Documentation folder A symbolic link inside Documentation/ (for example an AGENTS.md or CLAUDE.md link created by AI tooling) breaks the renderer's file walk. Add a note to the rendering prerequisites. Assisted-by: Claude Fable 5 Signed-off-by: Sebastian Mendel --- Documentation/Reference/FileStructure.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Documentation/Reference/FileStructure.rst b/Documentation/Reference/FileStructure.rst index 8ca018f5..3c37dee0 100644 --- a/Documentation/Reference/FileStructure.rst +++ b/Documentation/Reference/FileStructure.rst @@ -40,6 +40,12 @@ Further conventions are: * Code examples to be included should start with an underscore, for example :file:`_Services.yaml`. +.. note:: + Do not place symbolic links inside the :path:`Documentation` folder. The + rendering walks the directory tree literally; a symlink (for example an + :file:`AGENTS.md` or :file:`CLAUDE.md` link created by AI tooling) breaks + the file walk and thereby the rendering. + .. _full-documentation: Full documentation in reST