From 6e6d3f9d12899bb98b8df519159581f655e49e91 Mon Sep 17 00:00:00 2001 From: mikeCRL Date: Mon, 17 Nov 2025 15:19:31 -0500 Subject: [PATCH] Fix includes path and add review guidance in AGENTS.md - Correct `_include` to `_includes` (with an 's') - Clarify that includes are relative to `src/current` - Add reminder to read all included files when reviewing a doc --- src/current/AGENTS.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/current/AGENTS.md b/src/current/AGENTS.md index 1c286e0df67..c3e1dc274de 100644 --- a/src/current/AGENTS.md +++ b/src/current/AGENTS.md @@ -38,10 +38,12 @@ For includes that we can assume only apply to specific versions, though in some Note: The Liquid variable `{{page.version.version}}` resolves to the major version in the path of the page where it is used (e.g. `v25.4`). References to version-specific includes often use this, allowing the same page content that's used across versions to show different versions of an include, based on the current version being rendered. For example, `{% include {{page.version.version}}/misc/cert-auth-using-x509-subject.md %}`. -The includes are all located in subdirectories of the `_include` directory, i.e., +The includes are all located in subdirectories of the `_includes` directory (relative to `src/current`), i.e., -- `_include/common` for widely shared things -- `_include/cockroachcloud` for Cloud -- `_include/v25.4` for v25.4-specific content +- `_includes/common` for widely shared things +- `_includes/cockroachcloud` for Cloud +- `_includes/v25.4` for v25.4-specific content + +When reviewing documentation pages, make sure to read and follow all included files to get the complete picture of what users see