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