Skip to content
Kilavuz Kilavuz
Blog

Getting Started Guide

This guide walks a brand-new user through the core Kilavuz flows: signing up, creating a first project and question tree, reordering and softly deleting questions, and exporting to Markdown.

1. Sign up

  1. Open https://kilavuz.app in your browser.
  2. Click Sign up in the top-right corner.
  3. Fill in your email and password in the form. The form controls provided by the Wasp SDK stay in English; that limitation is documented in the README.
  4. Click the verification link that arrives in your inbox.

If the verification email never arrives, see the “Skip email verification in development” section of the Security and privacy guide.

2. Create your first project

After authenticating, the application routes you to the Projects dashboard. There:

  • Click New project.
  • Give the project a short title and an optional description.
  • Save.

Each project hosts an independent question tree. To switch between projects, use the project selector in the upper left.

3. Build your question tree

While inside a project:

  • Use the + Question button to add a root-level question.
  • Use the + next to any row to create a child question.
  • Drag and drop rows to reorder. Hierarchy is preserved during reordering: a child stays under its parent.

Soft delete

To delete a question:

  1. Click the trash icon at the right end of the row.
  2. The delete dialog shows the count of direct children.
  3. On confirmation, the target record is stamped with deletedAt; children are preserved and remain unorphaned.

This behavior is implemented by softDeleteQuestion in app/src/question-review/operations.ts; see the API reference for details.

4. Export to Markdown

To export a tree:

  1. Click the Export button in the upper right.
  2. The file produced by the exportQuestionsAsMarkdown endpoint downloads into your browser with Content-Type: text/markdown and Content-Disposition: attachment headers.
  3. The output numbers questions starting at the root using 1, 1.1, 1.1.2, and indents each level by two spaces.

5. Sign out

From the user menu in the upper right, choose Sign out. The sign-out flow provided by the Wasp SDK clears all session cookies; your cookie-consent preferences are stored separately under localStorage["kilavuz.cookie-consent"] and are restored on the next visit.

What’s next?