microsoft / BotFramework-Composer

Dialog creation and management for Microsoft Bot Framework Applications
https://docs.microsoft.com/en-us/composer/
MIT License
870 stars 372 forks source link

Microsoft.Bot.Builder.AI.Orchestrator package documentation link goes to root of dotnet repo #8158

Open GeoffCoxMSFT opened 3 years ago

GeoffCoxMSFT commented 3 years ago

Describe the bug

The documentation link for the package points directly at https://github.com/Microsoft/botbuilder-dotnet

Version

main as of 6/21/2021 (R14 development)

Browser

OS

To Reproduce

Steps to reproduce the behavior:

  1. New C# empty bot project
  2. Add package
  3. Search for orchestrator
  4. Select Microsoft.Bot.Builder.AI.Orchestrator package
  5. Inspect documentation link

Expected behavior

Should go to specific documentation about the orchestrator package. Prefer if it went to a bot framework documentation page, but minimum is a readme at https://github.com/microsoft/botbuilder-dotnet/tree/main/libraries/Microsoft.Bot.Builder.AI.Orchestrator Recommend going to aka.ms/ link

Screenshots

N/A

Additional context

cwhitten commented 3 years ago

@scheyal FYI

taicchoumsft commented 3 years ago

Thanks for reporting this @GeoffCoxMSFT , this PR should solve this problem (as you suggested, it'll go to an aka.ms link). We're updating the packages in the next few days to test this e2e.

taicchoumsft commented 3 years ago

@GeoffCoxMSFT , @scheyal , the dotnet 4.14.0 package in package manager shows this now (note that the wording matches the js version of the repo word for word here:

image

The View documentation link now goes to https://aka.ms/bf-orchestrator-package-readme

The js package is not displaying README correctly, investigating.

taicchoumsft commented 3 years ago

JS 4.14 packages now show the README:

image

JS view documentation link still goes to the js main repo page, but this is consistent with all our other npm packages, and because we can show readmes in JS version the see more links should suffice (nuget readme support is coming but we don't use it in SDK and Composer doesn't read it)

@darrenj , @scheyal , @GeoffCoxMSFT , please close if satisfactory or let me know if more work is needed here.