[FEATURE]: SHIP-0041 Documentation Restructure

[adambkaplan]

Feature Tracker

This is a higher level "feature tracker" for an approved enhancement proposal. Each discrete task to implement the feature should have its own child issue, linked to an appropriate Shipwright repository.

SHIP-0041: Documentation Restructure

Overview

SHIP-0041 proposes restructuring the documentation on shipwright.io to follow CNCF documentation best practices, organizing content into four main sections: Quick Start, Concepts, How To, and Reference. This restructure addresses issues with broken links, inability to preview content, flat documentation trees, and mixing of different documentation types.

Goals

• Reduce documentation bugs related to broken links
• Present existing content in ways that are relevant to end users and administrators
• Encourage end user evaluation and adoption
• Provide a single source of truth for documentation

Implementation Plan

The restructure will be implemented in phases:

1. Phase 1: Website Structure Setup - Create new documentation structure and Quick Start content
2. Phase 2: Content Migration - Migrate existing content from website and in-tree repositories
3. Phase 3: Redirects and Link Validation - Configure redirects and validate all links
4. Phase 4: Process Updates - Update contribution and maintainer guidelines

Child Issues

• shipwright-io/website#185: Create new documentation structure
• shipwright-io/website#186: Create Quick Start section content
• shipwright-io/website#187: Audit and categorize existing documentation
• shipwright-io/website#188: Migrate existing content to Concepts section
• shipwright-io/website#189: Migrate existing content to How To section
• shipwright-io/website#190: Migrate and enhance Reference section
• shipwright-io/website#191: Migrate in-tree documentation from build repository
• shipwright-io/website#192: Migrate in-tree documentation from cli repository
• shipwright-io/website#193: Migrate in-tree documentation from operator repository
• shipwright-io/website#194: Configure Hugo aliases for all moved content
• shipwright-io/website#195: Validate and fix all internal documentation links
• shipwright-io/website#196: Update documentation contribution guidelines
• shipwright-io/community#284: Update maintainer guidelines for documentation requirements

---

Generated-by: Cursor