Skip to content

Add TypeDoc links to README configuration tables #2576

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented May 29, 2025

This PR adds TypeDoc links to all configuration tables in README files throughout the repository, making it easier for developers to access detailed interface documentation.

Changes Made

Main README.md

  • Configuration section → Links to IConfiguration interface
  • ExtensionConfig section → Links to IExtensionConfig interface
  • ICookieMgrConfig section → Links to ICookieMgrConfig interface

Extension README files

  • Click Analytics: IClickAnalyticsConfiguration, IValueCallback, ICustomDataTags
  • PerfMark Measure: IPerfMarkMeasureConfiguration
  • OSPlugin: IOSPluginConfiguration
  • CfgSync: ICfgSyncConfig

Channel README files

  • Tee Channel: ITeeChannelConfig
  • Offline Channel: IOfflineChannelConfiguration

Implementation Details

  • Section headers now link to their TypeDoc interface pages: ## [Configuration](typedoc-url)
  • Property names in tables link to their specific documentation: [propertyName](typedoc-url#propertyName)
  • Main component uses: https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-web/interfaces/
  • Extensions/Channels use: https://microsoft.github.io/ApplicationInsights-JS/webSdk/interfaces/

Example

Before:

## Configuration

| Name | Type | Default | Description |
|------|------|---------|-------------|
| autoCapture | boolean | true | Automatic capture configuration |

After:

## [Configuration](https://microsoft.github.io/ApplicationInsights-JS/webSdk/interfaces/IClickAnalyticsConfiguration.html)

| Name | Type | Default | Description |
|------|------|---------|-------------|
| [autoCapture](https://microsoft.github.io/ApplicationInsights-JS/webSdk/interfaces/IClickAnalyticsConfiguration.html#autoCapture) | boolean | true | Automatic capture configuration |

All interface names were verified against actual TypeScript source files. Non-interface tables (snippet setup options, PowerShell script parameters) were intentionally excluded.

Fixes #2575.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits May 29, 2025 20:52
…n tables

Co-authored-by: MSNev <54870357+MSNev@users.noreply.github.com>
Co-authored-by: MSNev <54870357+MSNev@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] [Task] Add links for the README.md files pointing to the generated typedoc files Add TypeDoc links to README configuration tables May 29, 2025
@Copilot Copilot AI requested a review from MSNev May 29, 2025 20:58
Copilot finished work on behalf of MSNev May 29, 2025 20:58
Copy link
Collaborator

@MSNev MSNev left a comment

Choose a reason for hiding this comment

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

Co-authored-by: MSNev <54870357+MSNev@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented May 29, 2025

You have not used the correct base URL for each component, the URL's added return 404

example base URLs
...

Fixed the base URLs for all components. Updated all TypeDoc links to use the correct component-specific base URLs as provided. Commit 3467343.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

  • microsoft.github.io
    • Triggering command: curl -I REDACTED (dns block)
    • Triggering command: curl -s -o /dev/null -w %{http_code} REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot finished work on behalf of MSNev May 29, 2025 21:31
…plugin

Co-authored-by: MSNev <54870357+MSNev@users.noreply.github.com>
Copilot finished work on behalf of MSNev May 30, 2025 00:53
@MSNev
Copy link
Collaborator

MSNev commented May 30, 2025

Some README.md files have multiple tables for multiple configurations, update all of the tables if they exist and ensure that the links do not return 404 errors / page

Co-authored-by: MSNev <54870357+MSNev@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented May 30, 2025

Some README.md files have multiple tables for multiple configurations, update all of the tables if they exist and ensure that the links do not return 404 errors / page

Fixed all configuration tables that were missing TypeDoc links. Updated 6 additional configuration tables across 3 README files to ensure all property names link to their specific documentation. Found and fixed:

  • 1ds-post-js: IChannelConfiguration (28 properties) and IXHROverride (1 property)
  • offline-channel-js: IOfflineSenderConfig (4 properties + header link)
  • shared/1ds-core-js: IExtendedConfiguration (22 properties), IPropertyStorageOverride (2 properties), ICookieMgrConfig (8 properties)

All links use correct component-specific base URLs. Commit b9e9b9d.

Copilot finished work on behalf of MSNev May 30, 2025 01:11
… and export missing interfaces

Co-authored-by: MSNev <54870357+MSNev@users.noreply.github.com>
Copilot finished work on behalf of MSNev May 30, 2025 18:20
…IPageTags, IPageActionTelemetry, ICustomProperties, IContent, IOverrideValues, IPageActionOverrideValues, and Behavior enum

Co-authored-by: MSNev <54870357+MSNev@users.noreply.github.com>
Copilot finished work on behalf of MSNev May 30, 2025 18:48
Co-authored-by: MSNev <54870357+MSNev@users.noreply.github.com>
Copilot finished work on behalf of MSNev May 30, 2025 19:04
@MSNev MSNev marked this pull request as ready for review May 30, 2025 19:40
@MSNev MSNev requested a review from a team as a code owner May 30, 2025 19:40
@MSNev MSNev enabled auto-merge (squash) May 30, 2025 19:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Task] Add links for the README.md files pointing to the generated typedoc files
3 participants