cognitive/docs/templates/documentation_templates_index.md

Documentation Templates Index

---

title: Documentation Templates Index type: index status: stable created: 2024-02-06 tags:

• index
• templates
• documentation semantic_relations:
• type: implements links: ../concepts/knowledge_organization
• type: relates links:
  • ../guides/implementation_guides_index
  • ../concepts/concept_documentation_index

---

Overview

This directory contains templates for creating various types of documentation in the cognitive modeling system.

Core Templates

Documentation Types

• concept_template - Core concept documentation
• guide_template - Implementation guide
• api_template - API documentation
• example_template - Usage example

Component Templates

• model_template - Model documentation
• algorithm_template - Algorithm documentation
• class_template - Class documentation
• function_template - Function documentation

Research Templates

• experiment_template - Experiment documentation
• analysis_template - Analysis documentation
• results_template - Results documentation

Specialized Templates

Development

• package_component - Package component
• tool_template - Tool documentation
• script_template - Script documentation

Testing

• test_template - Test documentation
• benchmark_template - Benchmark documentation
• validation_template - Validation documentation

Integration

• integration_template - Integration guide
• plugin_template - Plugin documentation
• extension_template - Extension documentation

Content Templates

Structure

• index_template - Index page
• overview_template - Overview document
• reference_template - Reference document

Components

• section_template - Section structure
• example_block - Example block
• note_block - Note block

Metadata

• frontmatter_template - YAML frontmatter
• metadata_block - Metadata section
• tag_block - Tag organization

Format Guidelines

Markdown

• markdown_guide - Markdown usage
• formatting_guide - Text formatting
• link_guide - Link formatting

Code

• code_block - Code formatting
• comment_block - Comment formatting
• docstring_template - Docstring format

Diagrams

• mermaid_template - Mermaid diagrams
• graph_template - Graph visualization
• flowchart_template - Flowchart design

Template Usage

Getting Started

• template_usage - How to use templates
• template_examples - Example usage
• template_checklist - Usage checklist

Best Practices

• naming_conventions - Naming guidelines
• structure_guidelines - Structure guidelines
• style_guidelines - Style guidelines

Customization

• template_customization - Customization guide
• extension_guide - Extension guide
• theme_customization - Theme customization

Related Sections

• ../guides/implementation_guides_index
• ../concepts/concept_documentation_index
• ../examples/usage_examples_index

Contributing

• template_contribution - Contributing new templates
• template_review - Template review process
• template_maintenance - Template maintenance