Add github action to sync api docs to the user docs site

snyk / user-docs

Gitbook documentation repo.

https://docs.snyk.io/

22 stars 183 forks source link

Closed tinygrasshopper closed 3 months ago

tinygrasshopper commented 4 months ago

Currently this generates references docs, based on the tags supplied in the open api docs
Will add altering if the job fails as a separate PR

jgresty commented 4 months ago

Oh and alerting, how will we know if this fails?

tinygrasshopper commented 3 months ago

I can see there were a lot of notes that were previously on Apiary that have been lost on the new V1 docs.

Yep, will add that feature as a followup PR

I'm still concerned what will happen if this script runs before a previous pull request is merged

The default behaviour of the PR action is to merge it into the previous PR