Create Contributing Guide for GAIA Documentation #279
Description
Problem
There's confusion around how to update the documentation for GAIA (amd-gaia.ai). The documentation contribution process needs clarification regarding what exactly goes into the documentation and when to use different documentation types.
Proposed Solution
Create a comprehensive contributing guide that clarifies:
-
Documentation Types:
- What constitutes a "guide" or "playbook"
- When to create a "specification"
- When to create a "reference"
- Differences between these types and when to use each
-
Contribution Process:
- How to propose documentation updates
- Review process for documentation changes
- Style guidelines and formatting standards
- Where different types of documentation should live
-
Examples:
- Provide examples of well-structured guides, playbooks, specifications, and references
- Include templates for each documentation type
Acceptance Criteria
- Contributing guide document created
- Clear definitions for guides, playbooks, specifications, and references
- Process documented for submitting documentation changes
- Examples and templates provided
- Guide published and linked from main documentation
Context
This stems from recent confusion when attempting to update amd-gaia.ai documentation. Having clear guidelines will help contributors understand what type of documentation to create and how to structure it properly.