Rebased off master and responded to PR comments

Author: zelliott

apps/api-extractor/src/api/IConfigFile.ts

@@ -144,8 +144,8 @@ export interface IConfigDocModel {
   includeForgottenExports?: boolean;
 
   /**
-   * The URL to the `<projectFolder>` token where the project's source code can be viewed on a website like GitHub or
-   * Azure DevOps.
+   * The base URL where the project's source code can be viewed on a website such as GitHub or
+   * Azure DevOps. This URL path corresponds to the `<projectFolder>` path on disk.
    *
    * @remarks
    * This URL is concatenated with the file paths serialized to the doc model to produce URL file paths to individual API items.

apps/api-extractor/src/generators/ApiModelGenerator.ts

@@ -1138,6 +1138,6 @@ export class ApiModelGenerator {
       pos: declaration.pos
     });
 
-    return path.relative(this._collector.extractorConfig.projectFolder, sourceLocation.sourceFilePath);
+    return path.posix.relative(this._collector.extractorConfig.projectFolder, sourceLocation.sourceFilePath);
   }
 }

apps/api-extractor/src/schemas/api-extractor-template.json

@@ -218,8 +218,8 @@
     // "includeForgottenExports": false,
 
     /**
-     * The URL to the `<projectFolder>` token where the project's source code can be viewed on a website like GitHub or
-     * Azure DevOps.
+     * The base URL where the project's source code can be viewed on a website such as GitHub or
+     * Azure DevOps. This URL path corresponds to the `<projectFolder>` path on disk.
      *
      * This URL is concatenated with the file paths serialized to the doc model to produce URL file paths to individual API items.
      * For example, if the `projectFolderUrl` is "https://github.com/microsoft/rushstack/tree/main/apps/api-extractor" and an API

apps/api-extractor/src/schemas/api-extractor.schema.json

@@ -108,7 +108,7 @@
           "type": "boolean"
         },
         "projectFolderUrl": {
-          "description": "The URL to the `<projectFolder>` token where the project's source code can be viewed on a website like GitHub or Azure DevOps. This URL is concatenated with the file paths serialized to the doc model to produce URL file paths to individual API items. For example, if the `projectFolderUrl` is \"https://github.com/microsoft/rushstack/tree/main/apps/api-extractor\" and an API item's file path is \"api/ExtractorConfig.ts\", the full URL file path would be \"https://github.com/microsoft/rushstack/tree/main/apps/api-extractor/api/ExtractorConfig.js\". Can be omitted if you don't need source code links in your API documentation reference.",
+          "description": "The base URL where the project's source code can be viewed on a website such as GitHub or Azure DevOps. This URL path corresponds to the `<projectFolder>` path on disk. This URL is concatenated with the file paths serialized to the doc model to produce URL file paths to individual API items. For example, if the `projectFolderUrl` is \"https://github.com/microsoft/rushstack/tree/main/apps/api-extractor\" and an API item's file path is \"api/ExtractorConfig.ts\", the full URL file path would be \"https://github.com/microsoft/rushstack/tree/main/apps/api-extractor/api/ExtractorConfig.js\". Can be omitted if you don't need source code links in your API documentation reference.",
           "type": "string"
         }
       },