search

microsoft / api-guidelines

Microsoft REST API Guidelines
Other
22.69k stars 2.71k forks source link

Add anchors to all Azure guidelines for direct linking #400

Closed mikekistler closed 2 years ago

mikekistler commented 2 years ago

This PR adds a unique anchor tag to all guidelines in the Azure REST API Guidelines. This will allow tooling to link directly to a specific guideline when needed.

I also made a few minor reorganizations in the process. For example, there were a few rules about JSON structure that were in another section, so I moved them to the JSON section.

I also fixed many markdownlint errors -- trailing whitespace, link-target casing, etc. None of these change make any change to the rendered guidance.

mikekistler commented 2 years ago

@markweitzel I have rebased on top of #387 and ensured all rules are covered. This is ready for review / merge.

daviwil commented 2 years ago

This is a major improvement, but a little hard to get at the anchor name without looking at the page source. Not the worst thing in the world, though.

weidongxu-microsoft commented 2 years ago

A different topic. Reminded by the fix on spelling in the PR, should we have a CI to run cspell (or some other lint tool) on it?

We had only a few words needs allow list, and a genuine incorrect one "simpify".

4:6 - Unknown word (markdownlint)
34:17 - Unknown word (versionable)
83:157 - Unknown word (CLI's)
84:39 - Unknown word (blobstore)
84:50 - Unknown word (servicebus)
85:59 - Unknown word (CLI's)
86:53 - Unknown word (blobcontainer)
86:68 - Unknown word (myqueue)
111:103 - Unknown word (Cádiz)
202:39 - Unknown word (DDTHH)
212:7 - Unknown word (useragent)
213:1 - Unknown word (traceparent)
214:1 - Unknown word (tracecontext)
243:122 - Unknown word (fixdate)
245:24 - Unknown word (fixdate)
276:15 - Unknown word (simpify)
720:127 - Unknown word (odata)
1232:153 - Unknown word (subsecond)