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

Basic documentation that's missing from the website #1587

Open
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

bugarela
Copy link
Collaborator

@bugarela bugarela commented Feb 4, 2025

Hello :octocat:

This is a website revamp ✨. I reorganized the whole structure, and added several new pages:

  • Introduction > Why?
  • Introduction > Quint Basics
  • Introduction > Language Basics
  • Using specifications > Checking properties
  • Using specifications > Model-based Testing
  • How the tools work > Model checkers
  • How the tools work > Understanding the simulator

You can check a preview here: https://gabriela-basic-docs--quint-docs.netlify.app/docs/getting-started

I'm looking for two things here:

  1. High level review, making sure there is nothing too out of place. Considering that the current website has zero information about some of the stuff I'm adding, I'm looking for merge this soon and not go into too much nitpicking while the current state is lacking so much.
  2. Any sort of feedback to be implemented on the future.

(1) is higher priority than (2) at this point, and we can always iterate after merging.

@bugarela bugarela marked this pull request as ready for review February 12, 2025 12:09
@bugarela bugarela requested review from 0xZakk, ivan-gavran and josef-widder and removed request for 0xZakk February 12, 2025 12:10
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.

1 participant