From bab5db93ca5d6abd0fb4b05591682aeaca6c71c0 Mon Sep 17 00:00:00 2001 From: skdas20 Date: Mon, 23 Feb 2026 16:00:36 +0000 Subject: [PATCH] docs: clarify project reference path base --- .../documentation/copy/en/project-config/Project References.md | 1 + packages/tsconfig-reference/copy/en/options/references.md | 2 ++ 2 files changed, 3 insertions(+) diff --git a/packages/documentation/copy/en/project-config/Project References.md b/packages/documentation/copy/en/project-config/Project References.md index 17bcedce8ec3..39ff50ed3ea6 100644 --- a/packages/documentation/copy/en/project-config/Project References.md +++ b/packages/documentation/copy/en/project-config/Project References.md @@ -68,6 +68,7 @@ Project references can solve all of these problems and more. ``` The `path` property of each reference can point to a directory containing a `tsconfig.json` file, or to the config file itself (which may have any name). +Reference `path` values are resolved relative to the `tsconfig.json` file they appear in. When you reference a project, new things happen: diff --git a/packages/tsconfig-reference/copy/en/options/references.md b/packages/tsconfig-reference/copy/en/options/references.md index 364304ac84b5..96fe11e1a502 100644 --- a/packages/tsconfig-reference/copy/en/options/references.md +++ b/packages/tsconfig-reference/copy/en/options/references.md @@ -6,4 +6,6 @@ oneline: "Specify an array of objects that specify paths for projects. Used in p Project references are a way to structure your TypeScript programs into smaller pieces. Using Project References can greatly improve build and editor interaction times, enforce logical separation between components, and organize your code in new and improved ways. +Each `path` entry in `references` is resolved relative to the `tsconfig.json` file that contains it. + You can read more about how references works in the [Project References](/docs/handbook/project-references.html) section of the handbook