Skip to content

Conversation

@ChronosSF
Copy link
Member

No description provided.

@ChronosSF ChronosSF requested a review from Copilot October 29, 2025 15:49
@ChronosSF ChronosSF added the status: in-development 🛠️ things that are not finished label Oct 29, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR refactors the API documentation path configuration to use a structured object-based approach instead of scattered string properties. The main change introduces ApiDocPaths interface to consolidate API documentation root paths and their overrides into a single, well-typed structure.

Key changes:

  • Introduced ApiDocPaths and ApiDocOverride interfaces for better type safety
  • Refactored apiDocRoot from string to object with default and override properties
  • Consolidated override logic previously spread across multiple properties (apiDocOverrideRoot, apiDocOverridePackages, apiDocOverrideComponents) into structured override objects
  • Applied extensive code formatting fixes (spacing, indentation alignment)

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
src/ext/MappingLoader.ts Added new TypeScript interfaces ApiDocOverride and ApiDocPaths for API documentation path configuration
src/ext/MarkdownTransformer.ts Updated to use new ApiDocPaths type, refactored override logic to iterate through override array, extensive formatting improvements
docConfig.json Restructured API documentation configuration from flat properties to nested object structure with default and overrides arrays

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

ChronosSF and others added 2 commits October 30, 2025 10:49
…ing or encoding

Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
@ChronosSF ChronosSF requested a review from Copilot October 30, 2025 08:54
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (5)

src/ext/MarkdownTransformer.ts:142

  • The apiRoot parameter is now of type ApiDocPaths (an object), but is being used as a string. This should be apiRoot.default + blazorNamespace + "." + resolvedType + ".html" to access the default API root path.
            linkText = apiRoot + blazorNamespace + "." + resolvedType + ".html";

src/ext/MarkdownTransformer.ts:195

  • The apiRoot parameter is now of type ApiDocPaths (an object), but is being used as a string. This should be apiRoot.default + "classes/" + packageText + resolvedType.toLowerCase() + ".html" to access the default API root path.
                linkText = apiRoot + "classes/" + packageText + resolvedType.toLowerCase() + ".html";

src/ext/MarkdownTransformer.ts:197

  • The apiRoot parameter is now of type ApiDocPaths (an object), but is being used as a string. This should be apiRoot.default + "enums/" + packageText + resolvedType.toLowerCase() + ".html" to access the default API root path.
                linkText = apiRoot + "enums/" + packageText + resolvedType.toLowerCase() + ".html";

src/ext/MarkdownTransformer.ts:199

  • The apiRoot parameter is now of type ApiDocPaths (an object), but is being used as a string. This should be apiRoot.default + "interfaces/" + packageText + resolvedType.toLowerCase() + ".html" to access the default API root path.
                linkText = apiRoot + "interfaces/" + packageText + resolvedType.toLowerCase() + ".html";

src/ext/MarkdownTransformer.ts:201

  • The apiRoot parameter is now of type ApiDocPaths (an object), but is being used as a string. This should be apiRoot.default + "types/" + packageText + resolvedType.toLowerCase() + ".html" to access the default API root path.
                linkText = apiRoot + "types/" + packageText + resolvedType.toLowerCase() + ".html";

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@ChronosSF ChronosSF self-assigned this Oct 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants