Read the documentation of a component
The documentation of a component lives next to its code. You read it in Astrolabe, with the page list on the left and the outline on the right.
From the Documentation page
- In the left sidebar, click Documentation.
The page lists the components that have documentation: Document, Owner, Kind, Type and Actions.
- Click the name of a document, for example
customer-portal.
The documentation opens. At the top you see the Component, its Owner and its Lifecycle: click the component to open its page. Below:
| Where | What |
|---|---|
| Left | The pages of the documentation. Click one to open it |
| Middle | The page you read |
| Right, Table of contents | The headings of the page. Click one to jump to it |
A banner says a newer version is available
A newer version of this documentation is now available, please refresh to view. Click Refresh: the page reloads with the latest version.
From the component
- In the left sidebar, click Catalog and open the component.
- Click the Docs tab. Or, in the About card, click View TechDocs.
Find a document in the list
- On the Documentation page, click Filters.
- In the Personal block, click Starred to keep the documentation of your favorite components. Or pick a value in Owner or Tags.
- Click Close.
In the Actions column, the first button copies the link of the documentation, the second adds it to your favorites.
✅ That's it!