Guides

Choisir un parcours

Guide 1 — Première session OrbitWake

1. Commencez par l’introduction pour comprendre les surfaces du produit.
2. Suivez le démarrage rapide pour choisir entre web, CLI et VS Code.
3. Lisez Concepts clés avant de combiner modèles, contexte, projets et connecteurs.
4. Ouvrez ensuite le guide correspondant à votre environnement principal.

Ce parcours ne suppose pas qu’une fonctionnalité Preview soit disponible sur tous les comptes.

Guide 2 — Utiliser OrbitWake AI

1. Comprendre les surfaces avec AI — Vue d’ensemble.
2. Choisir ou laisser OrbitWake choisir un modèle avec Modèles et Routage automatique.
3. Comprendre l’historique avec Conversations.
4. Ajouter des fichiers via Fichiers.
5. Lire les références issues d’une recherche avec Sources.
6. Comprendre le contexte persistant avec Mémoire.
7. Si vous construisez un client, consultez ensuite API — Streaming.

Guide 3 — Travailler avec le CLI

1. Installer le CLI.
2. Connecter le compte.
3. Suivre le démarrage rapide CLI.
4. Utiliser le mode interactif ou les commandes.
5. Ajouter le contexte de projet et les fichiers.
6. Pour les opérations Git, lire Git et Permissions shell.
7. En cas de problème, utiliser CLI — Dépannage.

Guide 4 — Travailler sur du code

1. Commencez avec Code — Vue d’ensemble.
2. Comprenez les Projects et leurs limites private beta.
3. Préparez le contexte du dépôt.
4. Utilisez Génération de code pour les changements proposés.
5. Relisez avec Revue de code.
6. Terminez avec Workflows Git.

Guide 5 — Connecter GitHub

1. Lisez Connectors — Vue d’ensemble pour comprendre les permissions read/write/sensitive.
2. Suivez Connectors — GitHub pour le flux GitHub App + OAuth.
3. Vérifiez les approvals lorsqu’une action write ou sensitive en exige une.
4. Utilisez les logs d’activité Connector pour distinguer demande, approval et exécution.

Une déconnexion OrbitWake du Connector n’est pas équivalente à une désinstallation de la GitHub App ; la page GitHub documente cette différence.

Guide 6 — Utiliser OrbitWake dans VS Code

1. Installer l’extension.
2. Pairer VS Code avec un code à usage unique.
3. Découvrir les commandes.
4. Comprendre les réglages réels de la build actuelle.
5. Utiliser Ask pour du contexte éditeur ou Agent pour préparer une proposition multi-fichiers.
6. Relire le diff avant Apply et régénérer la proposition si le fichier local a changé.
7. En cas de problème, consulter VS Code — Dépannage.

Guide 7 — Comprendre ou intégrer l’API actuelle

1. Lire API — Vue d’ensemble pour comprendre la frontière entre API produit, IDE, routes publiques et internes.
2. Vérifier Authentification avant d’appeler une route protégée.
3. Construire le payload avec Requêtes.
4. Parser correctement Réponses.
5. Pour AI temps réel, utiliser Streaming SSE.
6. Traiter Erreurs et retries selon la catégorie.
7. Respecter Limites.

Guide 8 — Utiliser Memory sans perdre le contrôle du contexte

1. Lisez AI — Mémoire pour comprendre les scopes personal, workspace et project.
2. Utilisez une mémoire project uniquement avec une project key valide.
3. Gardez les contenus courts et précis : le runtime actuel limite une entrée à 4 000 caractères.
4. Utilisez les entrées pinned seulement lorsqu’une information doit peser fortement dans la récupération.
5. Consultez API — Limites / Memory pour les caps de lecture et retrieval.

Guide 9 — Dépanner méthodiquement

Commencez par identifier la surface qui échoue :

Capturez le message exact, la route ou la commande, le status HTTP lorsqu’il existe, et la version du client. Ne partagez pas de cookie, token IDE, secret webhook, credential provider ou clé privée.

Guides disponibles aujourd’hui

Cette page ne crée pas de pseudo-guides pour des surfaces qui ne sont pas encore implémentées. Les parcours ci-dessus pointent uniquement vers les pages actuellement présentes dans OrbitWake Developers.

Les sous-sections encore représentées par une recherche — par exemple certaines fonctions Agents, Cloud ou intégrations externes — resteront des placeholders jusqu’à ce que leur runtime réel soit disponible et vérifié.

Prochaine étape

La suite naturelle de la section Ressources est Exemples : snippets et scénarios copiables construits uniquement à partir des interfaces déjà vérifiées.