-
Notifications
You must be signed in to change notification settings - Fork 38
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
Website! #1459
Website! #1459
Conversation
✅ Deploy Preview for quint-docs canceled.
|
✅ Deploy Preview for quint-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, nice!
Left a few comments.
I went through the Getting Started guide and everything worked out as described :) I also think the guide is a very nice minimal example to get started with.
I would just recommend a "call to action" at the end of the guide, something like:
"If you want to learn more about language features, here are the tutorials[link].
If you want to see real-life Quint specifications, check out the examples[link]"
There's probably more destinations to link to. The goal would making it as clear as possible where you go after the getting started guide :)
Co-authored-by: Philip Offtermatt <57488781+p-offtermatt@users.noreply.github.com>
Hello
This creates a beautiful documentation website for Quint (I'm so excited!!!!!!!).
The PR consists of:
docs
folder..qnt
and related assets that used to live underdoc/
toexamples
and adapting many scripts involving themquint docs
command to generate a slightly better markdown, so the API reference for builtin operators looks better in the website (and using the search bar is a blast!)Content can be reviewed here. A small number of links have to point directly to the main website (quint-lang.org) because we generate external files with them (and relative paths wouldn't work), so they will be broken for now.
I'd appreciate specially a review of the actual website (rather than the source files, since it's mostly moving things around). Specially the Getting Started guide