Audit and categorize existing documentation for SHIP-0041

[adambkaplan]

Overview

This task audits all existing documentation in the website repository and categorizes content for migration as described in SHIP-0041.

Description

Review all existing documentation in the website repository and categorize content into Concepts, How To, or Reference sections. Identify content that needs restructuring or splitting to fit the new documentation model. Create a complete inventory and migration plan.

This audit should:

• Identify all documentation files in the current structure
• Categorize each document as Concept, How To, or Reference
• Identify documents that need restructuring (e.g., documents that mix concepts and tasks)
• Identify documents that should be split into multiple articles
• Create a migration plan documenting where each piece of content should go

Acceptance Criteria

• Complete inventory of existing docs created (markdown document)
• Each document categorized into appropriate section (Concepts, How To, or Reference)
• Documents requiring restructuring identified with notes on what changes are needed
• Documents requiring splitting identified
• Migration plan documented with clear mapping of old paths to new paths
• Inventory and migration plan reviewed by documentation maintainers

Dependencies

• Blocks: All content migration tasks (concepts, how-to, reference migration)
• Blocked by: Create new documentation structure (Issue 1)

Technical Notes

• Use tools like find or tree to inventory all markdown files in content/ directory
• Consider creating a markdown table to track the migration, which can be checked into the website git repository
• Review CNCF documentation best practices to ensure proper categorization
• Pay attention to documents that mix documentation types - these will need to be split

---

Generated-by: Cursor