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

Website! #1459

Merged
merged 24 commits into from
Jul 2, 2024
Merged

Website! #1459

merged 24 commits into from
Jul 2, 2024

Conversation

bugarela
Copy link
Collaborator

@bugarela bugarela commented Jun 30, 2024

Hello :octocat:

This creates a beautiful documentation website for Quint (I'm so excited!!!!!!!).

The PR consists of:

  • Setting up the Nextra framework
  • Moving many pages around and adapting many links. All the website is under the docs folder.
  • Moving .qnt and related assets that used to live under doc/ to examples and adapting many scripts involving them
  • Updating the quint 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!)
  • Defines a React component for a homepage. I'm not a frontend dev, I don't really know React, so that code might be a bit hacky. Contributions welcomed 😬
  • Adds two main pieces of content: a getting started page and some important FAQ answers.

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

Copy link

netlify bot commented Jun 30, 2024

Deploy Preview for quint-docs canceled.

Name Link
🔨 Latest commit 9597052
🔍 Latest deploy log https://app.netlify.com/sites/quint-docs/deploys/6681ee89ef573d0008857cfa

Copy link

netlify bot commented Jun 30, 2024

Deploy Preview for quint-docs ready!

Name Link
🔨 Latest commit dc24fb7
🔍 Latest deploy log https://app.netlify.com/sites/quint-docs/deploys/66843c284d51f60008e08c8e
😎 Deploy Preview https://deploy-preview-1459--quint-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@bugarela bugarela marked this pull request as ready for review July 1, 2024 00:06
@bugarela bugarela requested a review from p-offtermatt July 1, 2024 00:08
Copy link
Member

@p-offtermatt p-offtermatt left a 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 :)

docs/pages/community/index.mdx Outdated Show resolved Hide resolved
docs/pages/docs/faq.mdx Outdated Show resolved Hide resolved
bugarela and others added 3 commits July 1, 2024 09:02
Co-authored-by: Philip Offtermatt <57488781+p-offtermatt@users.noreply.github.com>
@bugarela bugarela enabled auto-merge July 2, 2024 17:43
@bugarela bugarela merged commit 2230744 into main Jul 2, 2024
19 checks passed
@bugarela bugarela deleted the gabriela/website branch July 2, 2024 17:49
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.

2 participants