CodeQL docs: update titles, add intros, and a few content updates (CodeQL for C/C++)#2869
Conversation
felicitymay
left a comment
There was a problem hiding this comment.
These changes all look good. I wonder if a couple of the introductions really add much to the title, but haven't commented because the PRs we've opened so far all view this differently. This is something that it would be good to discuss as a group - topics like the library introductions should probably have fairly similar introductions.
| NOTE: You can find related classes and features using the query console's auto-complete feature. You can also press *F3* to jump to the definition of any element; library files are opened in new tabs in the console. | ||
| .. pull-quote:: Note | ||
|
|
||
| You can find related classes and features using the query console's auto-complete feature. You can also press *F3* to jump to the definition of any element. Library files are opened in new tabs in the console. |
There was a problem hiding this comment.
Not required for this PR, but this note should probably have been deleted or clarified when we moved the documentation out of LGTM. We should probably check other languages for similar notes.
shati-patel
left a comment
There was a problem hiding this comment.
This looks good overall! (I've just made some suggestions to use the exact title when linking.)
I agree that we need to decide on more consistent intros (and possibly titles) across the languages. @felicitymay is making notes on these kind of tasks, so we can discuss that as a group later.
Co-Authored-By: Felicity Chapman <felicitymay@github.com> Co-Authored-By: Shati Patel <42641846+shati-patel@users.noreply.github.com>
389cc14 to
b1a2470
Compare
|
@shati-patel, @felicitymay: thanks for the comments and suggestions. Is there anything else you think I should address now? (I intend to revisit this when all of the other initial 'CodeQL for X' PRs have been completed, as mentioned on #2866 and #2823.) |
|
Thanks for the updates 👍 |
|
I removed the |
|
I think this is fine to merge as-is. |
The PR makes a start at addressing the tasks in https://github.com/github/product-documentation/issues/2163.
tldr for any members of the C analysis team who stumble upon this: We are trying to align the CodeQL documentation with the style and structure used in the GitHub help docs. There will be a series of PRs with updates. We'll try not to do anything that could change the technical meaning of the text and may ping you with questions as we are going along.
Summary of changes
CodeQL for C and C++homepage to include only the autogenerated TOC.TODO
Possibly next PR:
Later PRs:
For more info, see notes on https://github.com/github/product-documentation/issues/2163.