Recherche
Recherche intégrée
La fonctionnalité de recherche est intégrée à l’en-tête de chaque page :
- Recherche sémantique — Comprend le contexte et le sens, et non seulement les correspondances exactes des mots-clés
- Résultats instantanés — Voir les suggestions et les résultats pendant que vous tapez
- Aperçus des pages — Aperçu rapide du contenu correspondant avant de cliquer
- Amélioration des mots-clés — Les pages incluent des mots-clés de métadonnées pour améliorer la découverte
- Cliquez sur la barre de recherche dans l’en-tête (ou appuyez sur
/ pour la mettre en focus)
- Tapez votre question ou votre terme de recherche
- Parcourir les résultats ou sélectionner une suggestion
- Utilisez l’option Assistant IA pour les requêtes conversationnelles
Search results are ranked by relevance, with pages containing your keywords in metadata prioritised.
Assistant IA
L’Assistant IA est intégré à la fonctionnalité de recherche et fournit des réponses intelligentes à vos questions.
Capacités
- Répondre aux questions — Obtenir des réponses sur le protocole Livepeer, les produits et l’écosystème
- Expliquer les concepts — Comprendre des sujets complexes avec des explications claires
- Trouver la documentation — Découvrez les pages et tutoriels pertinents
- Conseils pour le code — Obtenez de l’aide avec des exemples de code et l’implémentation
- Cliquez sur la barre de recherche dans l’en-tête
- Tapez votre question en langage naturel
- Revoyez la réponse générée par l’IA
- Suivez les liens vers la documentation pertinente pour plus de détails
The AI Assistant uses the documentation content as its knowledge base to provide accurate, up-to-date information. For the most current details, always refer to the official documentation pages.
Intégrations IA
La documentation est conçue pour être compatible avec les IA et intègre:
- OpenAI — Pour la fonctionnalité d’assistant IA
- Claude — Support d’intégration IA alternative
- Autres LLMs — Contenu structuré optimisé pour l’analyse par IA
Contenu optimisé pour l’IA
La documentation est structurée pour être facilement consommée par les systèmes d’IA :
- Titres sémantiques — Des titres clairs et descriptifs qui transmettent un sens
- Métadonnées structurées — Métadonnées complètes pour une meilleure compréhension par les systèmes d’IA
- Références lisible par les machines — Spécifications OpenAPI, exemples JSON et données structurées
- Explications claires — Résumés et explications concis optimisés pour l’analyse par les LLM
Fonctionnalités de navigation
Navigation par onglets
Le contenu est organisé en onglets en fonction des rôles des utilisateurs :
- Accueil — Vue d’ensemble et mise en route
- À propos — Concepts principaux et détails du protocole
- Communauté — Ressources de la communauté
- Développeurs — Construction sur Livepeer
- Portails — Opérations des portails
- Orchestrateurs — Configuration et gestion des orchestrateurs
- Délégués — Staking et délégation
- Ressources — Hub de référence
Navigation de la barre latérale
- Collapsible — Maximiser l’espace de lecture en réduisant la barre latérale
- Hiérarchique — Groupes et sections organisés
- Ancres — Accès rapide aux démarrages rapides et au Hub de référence
- Navigation — Toujours savoir où vous êtes
Changement de version
Accédez à la documentation actuelle (v2) et à la documentation ancienne (v1) :
- Sélecteur de version — Dans l’en-tête, basculez entre les versions
- Contenu préservé — Tous le contenu v1 est conservé pour référence
- Indication claire — La version actuelle est clairement indiquée
Éléments interactifs
Onglets
Au sein des pages, les onglets séparent le contenu par contexte :
- Différents systèmes d’exploitation (Linux, macOS, Windows)
- Différents workflows (IA vs Vidéo, sur chaîne vs hors chaîne)
- Différents types d’utilisateurs ou cas d’utilisation
Vues
Les vues personnalisées affichent du contenu différent en fonction de :
- Système d’exploitation
- Chemin ou parcours de l’utilisateur
- Type de configuration
Étapes
Les instructions séquentielles utilisent le composant Étapes pour :
- Guides d’installation
- Processus de configuration
- Configurer des workflows
Groupes de cartes
Regroupements visuels pour :
- Pages du portail avec des points d’entrée clés
- Centres de ressources
- Collections de contenus connexes
Appels d’attention
Informations importantes mises en évidence avec :
- Info — Informations générales et conseils
- Conseil — Suggestions utiles
- Avertissement — Avertissements importants
- Danger — Avertissements critiques
- Remarque — Contexte supplémentaire
Mécanismes de feedback
Feedback sur la page
Donnez votre feedback sur n’importe quelle page :
- Votes Positif/Négatif — Feedback rapide sur l’utilité de la page
- Commentaires — Partager des commentaires ou des suggestions spécifiques
- Signalement des problèmes — Signaler des erreurs ou des informations obsolètes
Feedback mechanisms may vary based on Mintlify features. Check the bottom of pages for available feedback options.
Automatisations
La documentation inclut plusieurs pipelines d’automatisation pour garantir la précision et réduire la charge de travail manuelle :
Récupération des données
- Documentation externe — Récupérer et intégrer automatiquement les spécifications depuis GitHub
- Documentation de l’API — Générer la documentation de l’API à partir des spécifications OpenAPI
- Données dynamiques — Récupérer et afficher les versions GitHub, les messages de forum, les articles de blog
- Informations sur le code — Mettre automatiquement à jour les numéros de version et les exemples de code
Génération de contenu
- Métadonnées SEO — Générer automatiquement les balises SEO pour toutes les pages
- Références de l’API — Générer une documentation API à partir des spécifications OpenAPI
- Exemples de composants — Maintenir les exemples de composants à jour
Automatisations futures
Les automatisations prévues incluent :
- Traduction de la langue — Traduction automatique vers plusieurs langues
- Pages d’invite IA — Générer des guides de démarrage rapide à partir des invites
- Boucles de feedback — Intégration avec Discord et GitHub pour le feedback de la communauté
Fonctionnalités de structure des documents
Génération automatique de l’index de page
Le dépôt inclut une fonctionnalité interne docs qui maintientv2/pages les fichiers d’index synchronisés avec la structure actuelle du dossier et des fichiers markdown.
Ce qu’il génère :
v2/pages/<top-level-section>/index.mdx pour chaque dossier enfant direct sousv2/pages/v2/pages/index.mdx comme l’index agrégé racine
Règles de formatage :
- Les liens markdown au niveau racine apparaissent en premier en haut de chaque index de dossier de niveau supérieur.
- Les noms de dossiers et sous-dossiers sont affichés en tant que titres.
- Les liens sont affichés au format liste de liens markdown (
- [Title](/v2/fr/home/mission-control))
- Les liens incluent un indicateur d’alerte lorsqu’une page est absente de
docs.json navigation:
- [⚠️ Title](/v2/fr/home/mission-control).
Règles de validation et de nettoyage :
docs.json est traité comme une liste blanche de routes en lecture seule pour les indicateurs d’alerte.- La correspondance est stricte après normalisation (supprimer “
.md/.mdx, supprimer la fin “/index, supprimer les espaces en fin “/.)
- Fichiers imbriqués
index.mdx / index.md situés sous les sections de premier niveau sont automatiquement supprimés dans --write mode.
- En mode vérification (aucun
--write), les index imbriqués provoquent un échec jusqu’à ce qu’ils soient supprimés.
Comportement de l’automatisation :
- S’exécute en pré-validation lorsqu’il y a des fichiers en attente contenant
v2/pages modifications : node tools/scripts/generate-pages-index.js --staged --write --stage
- Prise en charge de la vérification/reconstruction manuelle :
node tools/scripts/generate-pages-index.jsnode tools/scripts/generate-pages-index.js --write --rebuild-indexes
This is a repository documentation feature (internal indexing), not an external automation workflow.
Accessibilité
La documentation est conçue avec l’accessibilité à l’esprit :
- Navigation au clavier — Prise en charge complète au clavier
- Prise en charge des lecteurs d’écran — HTML sémantique et étiquettes ARIA
- Contraste élevé — Lisible dans les thèmes clair et sombre
- Conception réactive — Fonctionne sur toutes les tailles d’écran
Documentation téléchargeable
La documentation est structurée pour être :
- Amie de l’IA — Optimisée pour l’analyse et l’intégration par l’IA
- Lisible par les machines — Formats structurés pour un accès programmable
- Exportable — Contenu disponible sous des formats adaptés à l’entraînement et à l’intégration des IA
Étapes suivantes
