[Migration prep] Docs: "QL language reference" category #3178
Conversation
shati-patel
changed the title
There was a problem hiding this comment.
The reorganization looks good 💚. I found very little to comment on, and one thing is unconnected...
Regarding your notes on Outstanding work, when you raise an issue for "Update https://help.semmle.com/QL/ql-reference-topics.html", please also note that the navigation pages and searches for all CodeQL documentation need to be reviewed too.
| For more information about the important concepts and syntactic constructs of QL, see the individual reference topics such as :doc:`Predicates <predicates>` and :doc:`Types <types>`. | ||
| The explanations and examples help you understand how the language works, and how to write more advanced QL code. |
There was a problem hiding this comment.
I'm not sure whether this is the right place for these links. Possibly we could leave the TOC in the sidebar to advertise the first set of links? Perhaps we could link to the specifications from the "Properties of QL" section?
There was a problem hiding this comment.
That's a good point. I've moved the links down to the "properties" section and changed them so they're relevant to the code example.
Co-Authored-By: Felicity Chapman <felicitymay@github.com>
|
Thanks for the review and the suggestions, @felicitymay 😄 |
|
Woops, I forgot to update the name that's displayed in the sidebar TOC and the page title! |
|
It's a good thing you're on the ball today, I completely missed those issues 🙍 |
when you're ready 😄
Summary
Closes https://github.com/github/semmle-docs/issues/21.
Changes in this PR
The other changes are formatting fixes and link updates.
Outstanding work
This restructuring will have some impact when we republish the documentation. I'll raise an issue with details, but I'm keeping note here for now:
docs/sphinxbuild target.