Blank state
空の ワークスペース view から始める
ワークスペース が未選択でも、曖昧な 初期画面 ではなく Open Workspace を明確に出します。
ドキュメント導線
既にあるワークスペースから始めるのが最短です。
インストール後に最初に何をするかを短く示すページ。
webサイト MVP における docs 初期画面 として、最初の一歩を案内してから repository docs へ送ります。
01
webサイト の docs 入口
02
より深い情報は repo docs
03
閲覧重視 オンボーディング
steps
3 ステップで始める
- Homebrew か DMG で KatanA をインストールする。
- Markdown ドキュメントを含むワークスペースフォルダを開く。
- 編集前に、まず読みやすさとダイアグラム表示を確認する。
onboarding
最初の ワークスペース を開く
まだドキュメントが開かれていない段階の初回導線です。
Menu path
メニューバー からも ワークスペース を開ける
native メニューバー の File -> Open Workspace から同じ導線へ入れます。
setup
最初に見ておくとよい設定
ワークスペース を開いた後は、テーマ、レイアウト、更新 あたりを見ると使い始めやすいです。
Theme
dark テーマ preset と live プレビュー
複数の テーマ preset と live プレビュー があり、見た目をアプリ内で調整できます。
Layout
table of contents と split direction
table of contents の表示、位置、split direction、pane order を レイアウト settings から触れます。
Updates
built-in update 設定
自動 update check の頻度や手動確認を app 内から確認できます。
workflow
最初に開くとよいもの
- README でプロジェクト概要とセットアップを掴む。
- ADR や spec を開いて設計意図を先に理解する。
- release notes を見て最近の挙動変化を追う。
deep / links