Docs: Consider describing how to import a database from GitHub in a bit more detail
- Dominant language
- CodeQL
- Stars
- 10.1k
- Forks
- 2.1k
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 141
Description
https://codeql.github.com/docs/codeql-for-visual-studio-code/analyzing-your-projects/#obtaining-a-local-database
says:
> GitHub stores CodeQL databases for over 200,000 repos on GitHub.com, which you can **download using the REST API** [Emphasis mine].
However, there is no need to download the databases using the REST API, we can simply use "Download Database from GitHub" in the extension. It's nice to know that there is an API, but a user might think that the only way is to use the API.
A few sentences earlier we _can_ indeed read this:
> You can add a database [...] from a project’s URL on GitHub.com.
So technically this is already mentioned, but I think it's pretty easy to miss this sentence when reading the article.
Contributor guide
Assessment
This issue has not been assessed yet.