search

OneDrive / apidoctor

Application for validating API documentation and generating test cases
Other
41 stars 27 forks source link

Add check to verify tab structure #185

Closed millicentachieng closed 1 year ago

millicentachieng commented 1 year ago

We have cases reported of some documents having misplaced tabs. This task is to add a verification check to ensure tabs are not duplicated and that they are in the correct location.

angelgolfer-ms commented 1 year ago

Just wanted to add, this check should call out an API Doctor error so that the PR author can remove lines such as below, that the author has accidentally copied and pasted from other examples:

# [HTTP](#tab/http)

Without doing so, the example can be displayed on the live site as truncated, without content under the H3 "Request" section, and the entire H3 "Response" section. Per @stevewilkins1123 , this is not uncommon in the existing docs. Owing to the severity of the behavior (examples are truncated), please prioritize accordingly. Thanks!