Skip to content

Commit 6e6d3f9

Browse files
committed
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
1 parent f07eaea commit 6e6d3f9

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

src/current/AGENTS.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,12 @@ For includes that we can assume only apply to specific versions, though in some
3838

3939
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 %}`.
4040

41-
The includes are all located in subdirectories of the `_include` directory, i.e.,
41+
The includes are all located in subdirectories of the `_includes` directory (relative to `src/current`), i.e.,
4242

43-
- `_include/common` for widely shared things
44-
- `_include/cockroachcloud` for Cloud
45-
- `_include/v25.4` for v25.4-specific content
43+
- `_includes/common` for widely shared things
44+
- `_includes/cockroachcloud` for Cloud
45+
- `_includes/v25.4` for v25.4-specific content
46+
47+
When reviewing documentation pages, make sure to read and follow all included files to get the complete picture of what users see
4648

4749
<!-- eof -->

0 commit comments

Comments
 (0)