Début de la documentation

Commencez avec l'espace de travail existant.

Un guide concis pour vos premiers pas après l'installation.

Instructions initiales avant d'approfondir la documentation complète du dépôt.

01

Départ via le web

02

Docs du repo pour approfondir

03

Onboarding centré lecteur

Première session

Ouvrir des dossiers et expérimenter la doc en tant que lecteur

KatanA offre sa pleine valeur quand vous avez déjà un espace de travail Markdown existant.

premieres cinq minutes

Checklist des 5 premieres minutes

  • Ouvrir README dans le vrai workspace.
  • Ouvrir un fichier de spec architecture.
  • Ouvrir un markdown riche en diagrammes.
  • Verifier TOC et split preview.
  • Verifier les parametres d update une fois.

sdd et ai

Note flux SDD / AI

Utilisez KatanA pour lire et valider les specs avant de demander des modifications a un agent.

Premiers pas en 3 étapes

  • Installer KatanA via Homebrew ou DMG.
  • Ouvrir un dossier contenant des fichiers Markdown.
  • Vérifier la lisibilité et les diagrammes avant d'éditer.

Ouvrir votre premier espace

Le flux initial quand aucun document n'est encore ouvert.

État vide

Partir de la vue vide

Même sans espace sélectionné, KatanA propose un bouton clair 'Ouvrir l'espace de travail'.

Chemin menu

Ouvrir l'espace via le menu

Accessible via le menu natif : Fichier -> Ouvrir l'espace de travail.

Premiers réglages recommandés

Après l'ouverture, vérifiez thèmes, mises en page et mises à jour pour la meilleure expérience.

Thème

Thèmes sombres et vue live

Ajustez les prédéfinis de design dans l'app et visualisez les changements instantanément.

Mise en page

TOC et direction de fractionnement

Configurez la table des matières, la direction du split et l'ordre des volets.

Mises à jour

Config des updates dans l'app

Gérez la fréquence de vérification et les mises à jour manuelles.

Shortcuts

Paramètres des Raccourcis Clavier

Personnalisez les raccourcis clavier pour les adapter à votre flux de travail.

Que ouvrir en premier ?

  • Contexte du projet via le README.
  • Intentions de design via les ADR ou spécifications.
  • Suivi des modifs dans les notes de version.

Support

Soutenez le développement de KatanA

Si cette commande d’installation vous aide, pensez à mettre une étoile ou faire un don.

How to star on GitHub