website-and-documentation/content/en/docs/components/TEMPLATE.md

title	linkTitle	weight	description
[Component Name]	[Short Name]	1	[Brief one-line description of the component]

{{% alert title="Draft" color="warning" %}} Editorial Status: This page is currently being developed.

• Jira Ticket: TICKET-XXX
• Assignee: [Name or Team]
• Status: Draft
• Last Updated: YYYY-MM-DD
• TODO:
  • Add detailed component description
  • Include usage examples and code samples
  • Add architecture diagrams
  • Review and finalize content {{% /alert %}}

Overview

[Detailed description of the component - what it is, what it does, and why it exists]

Key Features

• [Feature 1]
• [Feature 2]
• [Feature 3]

Purpose in EDP

[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities]

Repository

Code: [Link to source code repository]

Documentation: [Link to component-specific documentation]

Getting Started

Prerequisites

• [Prerequisite 1]
• [Prerequisite 2]

Quick Start

[Step-by-step guide to get started with this component]

1. [Step 1]
2. [Step 2]
3. [Step 3]

Verification

[How to verify the component is working correctly]

Usage Examples

[Use Case 1]

[Example with code/commands showing common use case]

# Example commands

[Use Case 2]

[Another common scenario]

Integration Points

• [Component A]: [How it integrates]
• [Component B]: [How it integrates]
• [Component C]: [How it integrates]

Architecture

[Optional: Add architectural diagrams and descriptions]

C4 charts

Embed C4 charts this way:

1. add a likec4-view with the name of the view {{< likec4-view view="components-template-documentation" project="architecture" title="Example Documentation Diagram" >}}

2. create the LikeC4 view somewhere in ./resources/edp-likec4/views, the example above is in ./resources/edp-likec4/views/documentation/components-template-documentation.c4

3. run task likec4:generate to create the webcomponent

4. if you are in task:serve hot-reload mode the view will show up directly

Component Architecture (C4)

[Add C4 Container or Component diagrams showing the internal structure]

Sequence Diagrams

[Add sequence diagrams showing key interaction flows with other components]

Deployment Architecture

[Add infrastructure and deployment diagrams showing how the component is deployed]

Configuration

[Key configuration options and how to set them]

Troubleshooting

[Common Issue 1]

Problem: [Description]

Solution: [How to fix]

[Common Issue 2]

Problem: [Description]

Solution: [How to fix]

Status

Maturity: [Production / Beta / Experimental]

Additional Resources

• [Link to external documentation]
• [Link to community resources]
• [Link to related components]

Documentation Notes

[Instructions for team members filling in this documentation - remove this section once complete]