google / osv.dev

Open source vulnerability DB and triage service.
https://osv.dev
Apache License 2.0
1.49k stars 186 forks source link

docs(faq): reorganise by category #2649

Closed andrewpollock closed 5 days ago

andrewpollock commented 6 days ago

Break the FAQ into 4 broad categories:

and place the existing entries under these.

Address various markdownlint complaints and a config file to disable

another-rex commented 5 days ago

You can host a preview version of the docs by changing the branch in your fork repository that github pages publish. E.g. https://github.com/andrewpollock/osv.dev/settings/pages

andrewpollock commented 5 days ago

You can host a preview version of the docs by changing the branch in your fork repository that github pages publish. E.g. https://github.com/andrewpollock/osv.dev/settings/pages

Thanks, https://andrewpollock.github.io/osv.dev/faq/ has it but the rendering is weird...

another-rex commented 5 days ago

That does look odd.. Are your settings same as here? https://github.com/google/osv.dev/settings/pages (except with a different branch)

andrewpollock commented 5 days ago

That does look odd.. Are your settings same as here? https://github.com/google/osv.dev/settings/pages (except with a different branch)

Ah, I had it set to the root instead of /docs. Now, how to force a republish? Push a no-op commit I guess?

andrewpollock commented 5 days ago

https://andrewpollock.github.io/osv.dev/faq/ is looking more like intended