Skip to main content
parlance — home

Quickstart

This guide takes you from a new account to your first audit in a few minutes.

1. Create your account

Open sign in and create an account with your email and a password — or continue with Google, GitHub, GitLab or Apple. You can add two-factor authentication and a passkey afterwards from Account → Security. See authentication for the full list of options.

2. Create a workspace and project

A workspace is your organisation. A project is a product or surface you want to keep honest.

  • From your dashboard, create a workspace (give it a name; the slug is derived for you).
  • Inside it, create a project — name, slug and a short description.

3. Set up a glossary and design tokens

A glossary is the shared vocabulary your contracts draw on — colour, spacing, type and motion.

  • Open your design system and create a colour glossary, then seed a preset.
  • Use Generate ramp to produce a 50–950 scale, and define your semantic light and dark roles in the Theme editor. Contrast is checked live against WCAG 2.2.

See glossaries & tokens for the detail.

4. Define a contract

A contract describes what a component must be. Each clause ties a property (for example background, padding-x or contrast) to a value sourced from your glossary.

  • Create a contract for a component (say, Button / primary).
  • Add clauses, choosing values from the glossary so design and code share one source of truth.

See UI contracts for clause types and component hierarchy.

5. Run your first audit

Point parlance at a surface — a design file, a code repository, a live URL or a native app — and run an audit. Findings are grouped by severity, and drift (where a surface disagrees with the contract) is flagged so you can fix it.

See audits to learn how findings and severities work.

Next steps