Skip to content

Fix includes path and add includes guidance in AGENTS.md #21165

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix includes path and add includes guidance in AGENTS.md #21165

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
10 changes: 6 additions & 4 deletions src/current/AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

<!-- eof -->
Loading