Docs entry point

Start with the workspace you already have.

A short path from install to first useful document.

This page acts as the docs landing page for the website MVP. It should answer 'what do I do first?' before sending deeper readers to the repository docs.

01

Website docs start here

02

Repository docs continue deeper

03

Viewer-first onboarding

steps

Getting started in three steps

  • Install KatanA through Homebrew or a direct download.
  • Open a workspace folder that already contains Markdown documentation.
  • Use KatanA to read, preview, and compare documents before making edits.

onboarding

Opening your first workspace

These captures show the first-run path before any documents are open.

Blank state

Start from the empty workspace view

When no workspace is open, KatanA shows a clear blank state instead of dropping users into an ambiguous landing view.

Menu path

Open a workspace from the menu bar

The same flow is reachable from the native menu bar through File -> Open Workspace.

setup

First settings worth checking

After opening a workspace, theme, layout, and update preferences are the first settings most users will care about.

Theme

Dark theme presets and live preview

KatanA already includes multiple theme presets plus a live preview panel, so users can tune appearance without leaving the app.

Layout

Table of contents and split direction

Layout settings expose table of contents visibility, TOC position, split direction, and pane order.

Updates

Built-in update preferences

The update screen makes automatic check frequency and manual update checks visible from inside the app.

workflow

What to open first

  • README files for project overview and setup facts.
  • ADRs and specs when you need design intent before coding.
  • Release notes when you need to understand recent behavior changes quickly.