Documentation Components
This guide describes the reusable documentation components available to documentation contributors. These components provide consistent layouts, formatting, and behavior throughout the Lowgile documentation.
Whenever possible, use these components instead of manually recreating layouts or repeating common documentation patterns.
1. Overview pages
Section titled “1. Overview pages”Use the OverviewPage component to create category landing pages such as Tutorials, Platform Concepts, or Developer Guides.
The component automatically renders:
- the overview introduction
- the overview summary
- the navigation card grid
Most overview pages only require frontmatter and introductory content.
Example
Section titled “Example”---title: Tutorials Overviewdescription: Learn how to build practical Lowgile applications.category: Tutorials
overviewSummary: sectionLabel: Tutorials itemLabel: Tutorials prerequisite: Basic understanding of the Lowgile platform outcome: Build practical Lowgile applications through guided tutorials---
<OverviewPage>
Lowgile tutorials...
</OverviewPage>Best practices
Section titled “Best practices”- Keep the introduction concise.
- Configure cards through the sidebar configuration.
- Configure the summary through frontmatter.
- Do not manually create overview layouts.
2. Table
Section titled “2. Table”Use the Table component for all structured tabular information, including configuration procedures, comparisons, reference information, mappings, matrices, and summaries.
Always supply explicit headers that describe the data. The number of headers must match the widest data row. Use fullWidth={true} when longer values need the available content width.
For a copyable code cell, pass an object in the supported format:
{ type: "code", value: "return process.request;" }Supported layouts
Section titled “Supported layouts”Property | Value
Section titled “Property | Value”Use for simple configuration.
<Table headers={["Property", "Value"]} data={[ ["Name", "request"], ["Context", "Input"], ["Type", "This.PurchaseRequest"], ]}/>Property | Value | Notes
Section titled “Property | Value | Notes”Use when additional implementation guidance is required.
<Table headers={["Property", "Value", "Notes"]} fullWidth={true} data={[ ["Prefix Icon", "Send", "Properties tab"], ["Color", "Primary", "Appearance tab"], ]}/>Property | Value | Action | Notes
Section titled “Property | Value | Action | Notes”Use for procedural configuration.
<Table headers={["Property", "Value", "Action", "Notes"]} fullWidth={true} data={[ ["Binding", "screen.request.vendor", "Review", "Connects the control to the entity property."], ["Label", "Vendor", "Set", "Displayed above the dropdown."], ]}/>Standard Action values
Section titled “Standard Action values”Use the following values consistently throughout the documentation.
| Action | Meaning |
|---|---|
| Set | Enter or change the value. |
| Review | Verify that the existing value is correct. |
| Update | Replace an existing value. |
| Leave default | Do not modify the platform default. |
| Optional | Configure only when required. |
| Not applicable | The property is not used in the current procedure. |
Best practices
Section titled “Best practices”- Choose headers that describe the actual values instead of relying on a predefined column layout.
- Keep every row consistent with the declared headers.
- Keep Notes concise and implementation-focused.
3. CalloutBubble
Section titled “3. CalloutBubble”Use CalloutBubble to highlight important information without interrupting the procedural flow.
Choose the callout type that best matches the purpose of the content.
Document each supported callout type here with an example.
4. InfoPanel
Section titled “4. InfoPanel”Use InfoPanel to display grouped metadata or summary information.
Typical uses include:
- overview summaries
- prerequisites
- estimated duration
- outcomes
Avoid using InfoPanel for procedural steps.
5. OverviewCardGrid
Section titled “5. OverviewCardGrid”OverviewCardGrid automatically generates overview cards from the sidebar configuration.
Cards should be maintained through the relevant sidebar configuration rather than manually editing overview pages.
6. Engineering Notes
Section titled “6. Engineering Notes”Engineering Notes are intended for documentation contributors only.
Use them to record:
- sidebar data sources
- component behavior
- implementation notes
- maintenance guidance
Always enclose Engineering Notes inside MDX comments so they are not rendered in the published documentation.
{/*Engineering Notes
...*/}7. Design principles
Section titled “7. Design principles”The documentation component system is designed around the following principles:
- Reuse components rather than duplicating layouts.
- Configure behavior through frontmatter whenever possible.
- Keep documentation pages focused on content rather than presentation.
- Maintain a consistent reading experience throughout the documentation.
- Standardize common documentation patterns using reusable components.