Repository navigation
docs: clarify remote script folders - #1477
Merged
Merged
Conversation
Note that the folders need to be in the root of the _remote_ repository, and reword to avoid confusing two meanings of the word "scripts".
| You can use [`extends`](./extends.md) but the paths must be relative to the remote repository root. | ||
|
|
||
| If you provide [`scripts`](./scripts.md) in a remote config file, the [scripts](./source_dir.md) folder must also be in the **root of the repository**. | ||
| If you provide [`scripts`](./scripts.md) in a remote config file, the [script `source_dir`](./source_dir.md) must also be in the **root of the remote repository**. |
There was a problem hiding this comment.
Describe the relative path behavior
The implementation resolves source_dir relative to the remote repository root and supports nested paths, while โmust also be in the rootโ implies that only a direct child of the root is valid. Describing the resolution rule directly avoids prompting users to restructure valid remote repositories.
Suggested change
| If you provide [`scripts`](./scripts.md) in a remote config file, the [script `source_dir`](./source_dir.md) must also be in the **root of the remote repository**. | |
| If you provide [`scripts`](./scripts.md) in a remote config file, the [script `source_dir`](./source_dir.md) path is resolved relative to the **root of the remote repository**. |
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
mrexox
approved these changes
Aug 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes # (issue)
Context
Changes
Note that the folders need to be in the root of the remote repository, and reword to avoid confusing two meanings of the word "scripts".
Confidence Score: 4/5
The PR is safe to merge, though the new wording should describe
source_diras relative to the remote repository root to avoid implying that nested paths are invalid.The documentation correctly distinguishes the remote repository from the consuming repository, but its location wording is narrower than the implementationโs relative-path behavior.
Files Needing Attention: docs/configuration/remotes.md
Reviews (1): Last reviewed commit: "docs: clarify remote script folders" | Re-trigger Greptile