@jmruthers/pace-core 0.5.76 → 0.5.78

package/docs/documentation-templates.md

@@ -1,539 +0,0 @@
-# PACE Core Documentation Templates
-
-> **📝 For Contributors** | [← Documentation Home](./README.md) | [Style Guide](./style-guide.md)
-
-Standard templates for creating consistent, high-quality PACE Core documentation.
-
----
-
-## Navigation Template
-
-Use this pattern at the top of every documentation file:
-
-```markdown
-# [Page Title]
-
-> **📚 Topic Category**: Description | [← Back](./README.md) | [Next: Related Topic →](./next-topic.md)
-
-[Brief one-sentence description of what this page covers]
-```
-
-### Example
-
-```markdown
-# DataTable Component Guide
-
-> **📚 Implementation Guide**: Interactive data management | [← Back to Docs](./README.md) | [Next: Forms →](./forms.md)
-
-Complete guide to implementing interactive data tables with sorting, filtering, and pagination.
-```
-
----
-
-## Standard File Header Template
-
-Every documentation file should start with this header:
-
-```markdown
-# [Feature Name]
-
-> **📚 Topic**: [When to use this] | [← Back](./README.md) | [API Reference](./api-reference/components.md)
-
-**[One-paragraph overview of the feature and its purpose]**
-
----
-
-**Last Updated**: 2025-02-08 | **Version**: v0.5.65+
-
-## Quick Summary
-
-- **Purpose**: [What problem this solves]
-- **Use Case**: [When to use this]
-- **Prerequisites**: [What you need to know first]
-- **Time Required**: [Estimated implementation time]
-```
-
----
-
-## Code Example Template
-
-Every code example must include these elements:
-
-```tsx
-// ✅ Complete Example Template
-// 1. All imports at the top
-import React, { useState, useEffect } from 'react';
-import { Button, DataTable, Card } from '@jmruthers/pace-core';
-
-// 2. TypeScript interfaces/types
-interface User {
-  id: string;
-  name: string;
-  email: string;
-}
-
-// 3. Complete component with error handling
-function UserList() {
-  const [users, setUsers] = useState<User[]>([]);
-  const [loading, setLoading] = useState(true);
-  const [error, setError] = useState<string | null>(null);
-
-  useEffect(() => {
-    // Data fetching logic with error handling
-    fetchUsers()
-      .then(setUsers)
-      .catch((err) => setError(err.message))
-      .finally(() => setLoading(false));
-  }, []);
-
-  // Error handling
-  if (error) return <div>Error: {error}</div>;
-  if (loading) return <div>Loading...</div>;
-
-  // Complete component implementation
-  return (
-    <div>
-      <h1>Users</h1>
-      <DataTable data={users} columns={[]} />
-    </div>
-  );
-}
-
-export default UserList;
-```
-
-### Required Elements Checklist
-
-- [ ] **All imports included** - Every import statement shown
-- [ ] **TypeScript types** - Proper interface/type definitions
-- [ ] **Error handling** - Shows how to handle errors
-- [ ] **Loading states** - Shows loading state handling
-- [ ] **Complete implementation** - Runnable, working code
-- [ ] **Comments** - Explains complex logic
-- [ ] **Realistic data** - Uses meaningful example data
-
----
-
-## Section Organization Template
-
-Every guide should follow this structure:
-
-```markdown
-# [Feature Name]
-
-[Header - see above]
-
-## Overview
-
-[What this feature does and why it exists]
-
-## Quick Start
-
-[Complete, runnable example that works immediately]
-
-## Detailed Guide
-
-### Prerequisites
-
-- [Requirement 1]
-- [Requirement 2]
-
-### Step-by-Step Implementation
-
-#### Step 1: [Action]
-
-[Code example with explanations]
-
-#### Step 2: [Action]
-
-[Code example with explanations]
-
-## Common Patterns
-
-### Pattern 1: [Name]
-
-[Explanation and example]
-
-### Pattern 2: [Name]
-
-[Explanation and example]
-
-## Advanced Usage
-
-[Advanced features and customization options]
-
-## Troubleshooting
-
-### Common Issue 1
-
-**Problem**: [Description]  
-**Solution**: [Fix]
-
-### Common Issue 2
-
-**Problem**: [Description]  
-**Solution**: [Fix]
-
-## Related Documentation
-
-- [Related Guide 1](./related-guide-1.md)
-- [Related Guide 2](./related-guide-2.md)
-- [API Reference](./api-reference/components.md)
-
-## Next Steps
-
-- [Link to next learning topic]
-```
-
----
-
-## API Reference Template
-
-For documenting components and hooks:
-
-```markdown
-# [Component/Hook Name]
-
-> **📚 API Reference**: [Category] | [← Back](./README.md)
-
-[One-paragraph description of what this component/hook does]
-
----
-
-## Usage
-
-```tsx
-import { [ComponentName] } from '@jmruthers/pace-core';
-
-function Example() {
-  return <[ComponentName] [key-prop="value"] />;
-}
-```
-
-## Props / Parameters
-
-### [Prop/Param Name] (required)
-
-**Type**: `[Type]`  
-**Default**: `[DefaultValue]`  
-**Description**: [What this prop/param does]
-
-**Example**:
-```tsx
-<[ComponentName] [prop-name]="value" />
-```
-
----
-
-## Examples
-
-### Basic Usage
-
-```tsx
-// Complete example with imports
-```
-
-### Advanced Usage
-
-```tsx
-// Complete example with imports
-```
-
-## Notes
-
-- [Important note 1]
-- [Important note 2]
-
-## Related
-
-- [Related Component/Hook](./related.md)
-- [Implementation Guide](./implementation-guides/feature.md)
-```
-
----
-
-## Migration Guide Template
-
-For documenting version migrations:
-
-```markdown
-# Migration Guide: [Feature/Version]
-
-> **📚 Migration Guide**: [Brief description] | [← Back](./README.md)
-
-[Overview of what changed and why migration is needed]
-
----
-
-## Breaking Changes
-
-### [Change 1]
-
-**Before**:
-```tsx
-// Old code
-```
-
-**After**:
-```tsx
-// New code
-```
-
-### [Change 2]
-
-**Before**:
-```tsx
-// Old code
-```
-
-**After**:
-```tsx
-// New code
-```
-
-## Step-by-Step Migration
-
-### Step 1: [Action]
-
-[Instructions with code]
-
-### Step 2: [Action]
-
-[Instructions with code]
-
-## Common Issues
-
-### Issue 1
-
-**Problem**: [Description]  
-**Solution**: [Fix]
-
-## Rollback Plan
-
-If you need to rollback:
-
-```bash
-# Rollback commands
-```
-
-## Related
-
-- [Breaking Changes](../breaking-changes.md)
-- [Release Notes](../CHANGELOG.md)
-```
-
----
-
-## Troubleshooting Guide Template
-
-```markdown
-# Troubleshooting: [Issue Name]
-
-> **📚 Troubleshooting**: [Category] | [← Back](./README.md)
-
-[Brief description of the issue and when it occurs]
-
----
-
-## Symptoms
-
-- [Symptom 1]
-- [Symptom 2]
-- [Symptom 3]
-
-## Common Causes
-
-1. **Cause 1**: [Explanation]
-2. **Cause 2**: [Explanation]
-3. **Cause 3**: [Explanation]
-
-## Solutions
-
-### Solution 1: [Fix Name]
-
-**When to use**: [When this solution applies]
-
-```bash
-# Commands or code
-```
-
-**Verify it worked**:
-```bash
-# How to check
-```
-
-### Solution 2: [Fix Name]
-
-**When to use**: [When this solution applies]
-
-[Code or instructions]
-
-## Prevention
-
-- [Prevention tip 1]
-- [Prevention tip 2]
-
-## Related
-
-- [Main Troubleshooting Guide](./README.md)
-- [Common Issues](./common-issues.md)
-```
-
----
-
-## Best Practices Template
-
-```markdown
-# Best Practices: [Topic Name]
-
-> **📚 Best Practices**: [Category] | [← Back](./README.md)
-
-[Overview of best practices for this topic]
-
----
-
-## Core Principles
-
-### Principle 1: [Name]
-
-**Why**: [Reason this principle exists]
-
-**Implementation**:
-```tsx
-// Example code
-```
-
-**Avoid**:
-```tsx
-// ❌ Bad example
-```
-
-**Prefer**:
-```tsx
-// ✅ Good example
-```
-
-### Principle 2: [Name]
-
-[Similar structure]
-
-## Common Patterns
-
-### Pattern 1: [Name]
-
-**Use when**: [When to use this pattern]
-
-**Example**:
-```tsx
-// Complete example
-```
-
-### Pattern 2: [Name]
-
-[Similar structure]
-
-## Anti-Patterns
-
-### ❌ Anti-Pattern 1: [Name]
-
-**Why it's bad**: [Reason]
-
-**Better approach**: [Better solution with example]
-
-## Performance Considerations
-
-- [Tip 1]
-- [Tip 2]
-- [Tip 3]
-
-## Security Considerations
-
-- [Security tip 1]
-- [Security tip 2]
-
-## Accessibility
-
-- [Accessibility tip 1]
-- [Accessibility tip 2]
-
-## Related
-
-- [Implementation Guide](./implementation-guides/feature.md)
-- [API Reference](./api-reference/components.md)
-```
-
----
-
-## Quick Reference Template
-
-For quick lookups:
-
-```markdown
-# Quick Reference: [Topic]
-
-> **📚 Quick Reference**: [Category] | [← Back](./README.md)
-
-Quick reference card for [topic].
-
----
-
-## Installation
-
-```bash
-npm install [package]
-```
-
-## Basic Usage
-
-```tsx
-import { [Component] } from '@jmruthers/pace-core';
-
-function Example() {
-  return <[Component] />;
-}
-```
-
-## Common Patterns
-
-| Pattern | Code | Description |
-|---------|------|-------------|
-| [Pattern 1] | `code` | [Description] |
-| [Pattern 2] | `code` | [Description] |
-
-## Cheat Sheet
-
-### [Category 1]
-- **Thing 1**: `code`
-- **Thing 2**: `code`
-
-### [Category 2]
-- **Thing 1**: `code`
-- **Thing 2**: `code`
-
-## See Also
-
-- [Full Guide](./full-guide.md)
-- [API Reference](./api-reference/components.md)
-```
-
----
-
-## Checklist for New Documentation
-
-Before publishing any documentation, verify:
-
-- [ ] Uses standard navigation template
-- [ ] Includes complete file header
-- [ ] All code examples follow template
-- [ ] Sections follow standard organization
-- [ ] Has "Related Documentation" section
-- [ ] Has "Next Steps" section
-- [ ] All links verified
-- [ ] Version metadata included
-- [ ] Reviewed for accuracy
-- [ ] Follows style guide
-- [ ] Typed checked (for code examples)
-
----
-
-**Related**: [Style Guide](./style-guide.md) | [Documentation Checklist](./DOCUMENTATION_CHECKLIST.md)