-
Notifications
You must be signed in to change notification settings - Fork 247
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
base: main
Are you sure you want to change the base?
Conversation
…n tables Co-authored-by: MSNev <54870357+MSNev@users.noreply.github.com>
Co-authored-by: MSNev <54870357+MSNev@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You have not used the correct base URL for each component, the URL's added return 404
example base URLs
- https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-teechannel-js
- https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-web
- https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-web-basic
- https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-core-js
Co-authored-by: MSNev <54870357+MSNev@users.noreply.github.com>
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 addressesI tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
…plugin Co-authored-by: MSNev <54870357+MSNev@users.noreply.github.com>
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>
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:
All links use correct component-specific base URLs. Commit b9e9b9d. |
… and export missing interfaces Co-authored-by: MSNev <54870357+MSNev@users.noreply.github.com>
extensions/applicationinsights-clickanalytics-js/src/applicationinsights-clickanalytics-js.ts
Outdated
Show resolved
Hide resolved
…IPageTags, IPageActionTelemetry, ICustomProperties, IContent, IOverrideValues, IPageActionOverrideValues, and Behavior enum Co-authored-by: MSNev <54870357+MSNev@users.noreply.github.com>
Co-authored-by: MSNev <54870357+MSNev@users.noreply.github.com>
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
IConfiguration
interfaceIExtensionConfig
interfaceICookieMgrConfig
interfaceExtension README files
IClickAnalyticsConfiguration
,IValueCallback
,ICustomDataTags
IPerfMarkMeasureConfiguration
IOSPluginConfiguration
ICfgSyncConfig
Channel README files
ITeeChannelConfig
IOfflineChannelConfiguration
Implementation Details
## [Configuration](typedoc-url)
[propertyName](typedoc-url#propertyName)
https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-web/interfaces/
https://microsoft.github.io/ApplicationInsights-JS/webSdk/interfaces/
Example
Before:
After:
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.