Lire la documentation d'un composant
La documentation d'un composant vit à côté de son code. Tu la lis dans Astrolabe, avec la liste des pages à gauche et le sommaire à droite.
Depuis la page Documentation
- Dans la barre latérale de gauche, clique sur Documentation.
La page liste les composants qui ont une documentation : Document, Propriétaire, Catégorie, Type et Actions.
- Clique sur le nom d'un document, par exemple
customer-portal.
La documentation s'ouvre. En haut, tu vois le Component, son Propriétaire et son Cycle de vie : clique sur le composant pour ouvrir sa page. En dessous :
| Où | Quoi |
|---|---|
| À gauche | Les pages de la documentation. Clique sur l'une d'elles pour l'ouvrir |
| Au milieu | La page que tu lis |
| À droite, Table of contents | Les titres de la page. Clique sur l'un d'eux pour y aller |
Une nouvelle version de cette documentation est maintenant disponible, veuillez rafraîchir pour la consulter. Clique sur Rafraîchir : la page se recharge avec la dernière version.
Depuis le composant
- Dans la barre latérale de gauche, clique sur Catalogue et ouvre le composant.
- Clique sur l'onglet Documentation. Ou, dans la carte À propos, clique sur Voir TechDocs.
Retrouver un document dans la liste
- Sur la page Documentation, clique sur Filtres.
- Dans le bloc Personnel, clique sur Favoris pour garder la documentation de tes composants favoris. Ou choisis une valeur dans Propriétaire ou Tags.
- Clique sur Fermer.
Dans la colonne Actions, le premier bouton copie le lien de la documentation, le second l'ajoute à tes favoris.
✅ C'est tout !
La suite : Ajouter une documentation à un composant.