Blank state
Start from an empty view
Even without a workspace selected, KatanA presents a clear 'Open Workspace' prompt.
Documentation Entry
Start with your existing workspace.
A concise guide to taking your first steps after installation.
Guidance on your first steps before diving into the full repository documentation.
01
Website docs entry point
02
Repo docs for deep dives
03
Viewer-focused onboarding
First Session
Open a folder and enter the documentation as a reader
KatanA provides the most value when you have an existing Markdown workspace.
first five minutes
First 5 minutes checklist
- Open README in your real workspace.
- Open one architecture spec file.
- Open one diagram-heavy markdown file.
- Confirm TOC and split preview behavior.
- Check update settings once.
sdd and ai
SDD / AI workflow note
Use KatanA to read and verify specs before asking an agent to edit them.
Get Started in 3 Steps
- Install KatanA via Homebrew or DMG.
- Open your workspace folder containing Markdown docs.
- Inspect readability and diagrams before you start editing.
Opening Your First Workspace
The initial flow when no documents are open yet.
Welcome
Access the Welcome screen
Revisit the Welcome screen anytime via the command palette to see feature highlights and keyboard shortcuts.
Recommended First Settings
After opening a workspace, check themes, layouts, and updates for the best experience.
Theme
Dark Theme Presets and Live Preview
Adjust the look with multiple presets and see changes live.
Layout
TOC and Split Direction
Configure TOC position, split direction, and pane order in the layout settings.
Updates
In-app Update Configuration
Manage update frequency and manual checks within the application.
Shortcuts
Keyboard Shortcuts Settings
Customize keyboard shortcuts to match your workflow seamlessly.
What to Open First
- Grab project context from the README.
- Understand design intent from ADRs or specs.
- Track recent changes in the release notes.