Skip to content

[TASK] Warn against symlinks inside the Documentation folder #543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
linawolf merged 1 commit into from
Aug 15, 2026
Merged

[TASK] Warn against symlinks inside the Documentation folder #543

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions Documentation/Reference/FileStructure.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down