Point d'entrée Docs

Commencez avec le espace de travail que vous possédez déjà.

Un court chemin depuis l'installation jusqu'au premier document utile.

Cette page fait office de page de destination de la documentation pour le site Web MVP. Il devrait répondre « que dois-je faire en premier ? » avant d'envoyer des lecteurs plus approfondis vers la documentation du référentiel.

01

Les documents du site Web commencent ici

02

Les documents Repository continuent plus profondément

03

Intégration du spectateur d'abord

steps

Commencer en trois étapes

  • Installez KatanA via Homebrew ou par téléchargement direct.
  • Ouvrez un dossier espace de travail qui contient déjà la documentation Markdown.
  • Utilisez KatanA pour lire, prévisualiser et comparer des documents avant d'apporter des modifications.

onboarding

Ouvrir votre premier espace de travail

Ces captures affichent le chemin de première exécution avant l'ouverture des documents.

État vide

Commencez à partir de la vue espace de travail vide

Lorsqu'aucun espace de travail n'est ouvert, KatanA affiche un état vide au lieu de laisser tomber les utilisateurs dans une vue d'atterrissage ambiguë.

Chemin de menu

Ouvrez un espace de travail depuis la barre de menu

Le même flux est accessible depuis la barre de menu native via Fichier -> Ouvrir Workspace.

setup

Premiers réglages à vérifier

Après avoir ouvert un espace de travail, les préférences de thème, de mise en page et de mise à jour sont les premiers paramètres qui intéresseront la plupart des utilisateurs.

Thème

Préréglages de thème sombre et live preview

KatanA comprend déjà plusieurs préréglages de thème ainsi qu'un panneau live preview, afin que les utilisateurs puissent régler l'apparence sans quitter l'application.

Mise en page

Table des matières et direction divisée

Les paramètres de mise en page exposent la visibilité de la table des matières, la position de la table des matières, la direction de division et l'ordre des volets.

Mises à jour

Préférences de mise à jour intégrées

L'écran de mise à jour rend visibles la fréquence des vérifications automatiques et les vérifications de mise à jour manuelles depuis l'intérieur de l'application.

workflow

Quoi ouvrir en premier

  • Fichiers README pour la présentation du projet et les faits de configuration.
  • ADRs et spécifications lorsque vous avez besoin d'une intention de conception avant de coder.
  • Notes de publication lorsque vous avez besoin de comprendre rapidement les changements de comportement récents.