Skip to content
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

Workaround to enable OpenAI documentation on learn.microsoft.com #31788

Merged
merged 3 commits into from
Nov 15, 2024

Conversation

danieljurek
Copy link
Member

@danieljurek danieljurek commented Nov 15, 2024

Work item to undo the workaround when proper support is implemented in type2docfx: #31787

Docs with changes in place: https://review.learn.microsoft.com/en-us/javascript/api/overview/azure/openai-readme?view=azure-node-preview&branch=djurek%2Fopenai-readme

The change in Docs-Toc.ps1 adds the OpenAI entry and then sorts the packages in Cognitive Services so that OpenAI ends up in the right place.

@danieljurek danieljurek changed the title Workaround to enable OpenAI documentation on learn.microsoft.com (rev… Workaround to enable OpenAI documentation on learn.microsoft.com Nov 15, 2024
Copy link
Member

@weshaggard weshaggard left a comment

Choose a reason for hiding this comment

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

Lets file an issue to remove this hack once the parser is updated correctly.

@danieljurek
Copy link
Member Author

Lets file an issue to remove this hack once the parser is updated correctly.

#31787

@danieljurek
Copy link
Member Author

One last set of changes at the end to ensure that the ToC is properly ordered:

  • Client (non-management) packages are sorted alphabetically and come first
  • Management entry with management packages appears AFTER all non-management packages

image

@danieljurek danieljurek enabled auto-merge (squash) November 15, 2024 21:23
Copy link
Member

@deyaaeldeen deyaaeldeen left a comment

Choose a reason for hiding this comment

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

Thank you so much for addressing this!

@danieljurek danieljurek merged commit c2a8656 into main Nov 15, 2024
28 checks passed
@danieljurek danieljurek deleted the djurek/openai-toc branch November 15, 2024 21:43
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.

4 participants