Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add links to Syntax page for each feature #1267

Merged
merged 5 commits into from
Dec 14, 2022
Merged

docs: Add links to Syntax page for each feature #1267

merged 5 commits into from
Dec 14, 2022

Conversation

richb-hanover
Copy link
Contributor

The Syntax page provides a terrific summary of the features of PRQL. This PR adds links (and a few new examples) from each feature to the relevant page in the Book.

This also disables Prettier for the table, since it wants to reformat all the spacing to align the column marks.

Copy link
Member

@aljazerzen aljazerzen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good. I didn't know you can link directly to the titles.

book/src/queries/syntax.md Outdated Show resolved Hide resolved
@richb-hanover
Copy link
Contributor Author

I didn't know you can link directly to the titles.

Yes - Good websites usually set an id="..." on or just above the heading. I find it by right-clicking on the heading in the browser, choosing Inspect from the dropdown and examining the HTML to find the id. Then tack that ID onto the end of the URL with #whatever-the-id-was

@aljazerzen aljazerzen merged commit a90d550 into PRQL:main Dec 14, 2022
@richb-hanover richb-hanover deleted the syntax-page branch December 14, 2022 19:14
@max-sixty
Copy link
Member

Thanks a lot @richb-hanover !

Did we exclude the annotations deliberately? It is quite niche so may well make sense...

@max-sixty
Copy link
Member

This is much easier to navigate!
image

@aljazerzen
Copy link
Member

Did we exclude the annotations deliberately?

See my suggestion under a "resolved" comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants