-
Notifications
You must be signed in to change notification settings - Fork 30
Open
Labels
kind/documentationCategorizes issue or PR as related to documentation.Categorizes issue or PR as related to documentation.
Description
Overview
This task migrates existing task-oriented documentation to the How To section as described in SHIP-0041.
Description
Move and restructure existing task-oriented documentation into the How To section. Organize into logical sub-sections (e.g., Installation, Running Builds, Configuration). This task may have sub-tasks for writing specific "how-to" articles if gaps are identified during migration.
The How To section should explain:
- How to perform specific types of builds
- How to install and configure Shipwright
- How to perform common tasks
- Step-by-step procedures
Acceptance Criteria
- All task-oriented content moved to
content/docs/how-to/ - Content organized into logical sub-sections (e.g., Installation, Running Builds, Configuration)
- Conceptual content separated and moved to Concepts section (if mixed)
- All internal links updated to new paths
- Hugo aliases configured for redirects from old paths
- Content reviewed for accuracy and clarity
- How To section has clear navigation and organization
Dependencies
- Blocks: Configure Hugo aliases (Issue 10)
- Blocked by: Audit and categorize existing documentation (Issue 3)
Technical Notes
- Use the migration plan from the audit task to identify which documents to migrate
- Organize content into logical sub-sections that make sense for users
- Update all internal markdown links to point to new paths
- Configure Hugo aliases in front matter for each moved document:
aliases: - /old/path/to/document
- Test that redirects work correctly in local Hugo preview
- Contributors should feel free to create sub-issues on this task for specific content to be migrated.
These sub-issues may be created after the audit task (Issue 3) is completed.
Generated-by: Cursor
Metadata
Metadata
Assignees
Labels
kind/documentationCategorizes issue or PR as related to documentation.Categorizes issue or PR as related to documentation.
Type
Projects
Status
No status