Skip to content

Commit

Permalink
chore: Add a warning about relative path resolution. (dotnet#9828)
Browse files Browse the repository at this point in the history
Add a warning about relative path resolution.

It's not obvious whether paths are resolved based on current working directory where docfx is called or based on location of `docfx.json` file.

It's worth to be explicit about it in the documentation.
  • Loading branch information
voroninp authored and p-kostov committed Jun 28, 2024
1 parent 308912e commit e515368
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/reference/docfx-json-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

The `docfx.json` file indicates that the directory is the root of a docfx project.

> [!IMPORTANT]
> All relative paths specified in config file are relative to the location of `docfx.json`
```json
{
"build": { },
Expand Down

0 comments on commit e515368

Please sign in to comment.