microsoftgraph / microsoft-graph-devx-api

Services API for Graph Explorer
MIT License
87 stars 35 forks source link

Multiple snippets tabs are selected in MS Graph Docs #1020

Closed adhiambovivian closed 2 years ago

adhiambovivian commented 2 years ago

image

zengin commented 2 years ago

This is likely a docs rendering bug unless we are not outputting the tabs in markdown format incorrectly. The JavaScript function that updates the links on click events come from here: https://github.com/microsoft/templates.docs.msft/blob/master/scripts/index-docs.js

Unfortunately code is minimized. We should probably reach out to team that owns that script to check if our markdown is in expected format.

millicentachieng commented 2 years ago

@zengin, as you've mentioned, this is a docs rendering bug but it's also a requirement that all tab sets in a page should be the same for synchronization. We usually get warnings each time the tab set is not uniform across a page and the docs team had already started adding the missing tabs manually like below.

image

I've updated API Doctor to ensure that we have matching tab sets in a page.

zengin commented 2 years ago

thanks for the detailed information @millicentachieng!