Skip to main content

Documentation Templates

This directory contains templates and guidelines for creating consistent documentation across the edge-ai project.

Available Templates​

Documentation Template​

  • File: [template-name].template
  • Purpose: Template for creating standardized documentation headers and structure
  • Usage: Copy and customize for new documentation files

The template provides:

  • Standardized header comment formats for Shell/YML and Python
  • Parameter documentation structure
  • Function/purpose descriptions
  • Usage examples
  • Dependency listings
  • Exit codes and error handling documentation
  • Related links and references

How to Use Templates​

  1. Copy the template file to your target location
  2. Replace [template-name] with your actual template name
  3. Fill in the specific details for your use case
  4. Follow the established patterns for consistency

For more comprehensive documentation templates and guidelines, see:

Contributing​

When adding new templates:

  1. Follow the existing naming conventions
  2. Include comprehensive documentation
  3. Provide clear usage examples
  4. Update this README to reference new templates