Skip to content

Create new documentation structure for SHIP-0041 #185

@adambkaplan

Description

@adambkaplan

Overview

This task implements the new documentation structure as described in SHIP-0041. The new structure organizes documentation into four main sections following CNCF best practices: Quick Start, Concepts, How To, and Reference.

Description

Create the new directory structure in the content/docs/ directory of the website repository:

  • content/docs/quick-start/ - For evaluators to quickly demonstrate Shipwright's value
  • content/docs/concepts/ - For explaining "what" and "why" in Shipwright
  • content/docs/how-to/ - For task-oriented documentation
  • content/docs/reference/ - For API specifications and reference materials

Set up Hugo front matter, navigation configuration, and ensure the theme properly supports the new structure. Create or update a landing page at /docs that provides clear links to all four sections.

Acceptance Criteria

  • New directory structure created: content/docs/quick-start/, content/docs/concepts/, content/docs/how-to/, content/docs/reference/
  • Hugo navigation menu configured for new sections
  • Landing page at /docs created with links to all four sections
  • Theme configuration updated to support new structure
  • CI/CD validates the new structure builds successfully
  • Local Hugo preview shows new structure correctly

Dependencies

  • Blocks: All content migration tasks (concepts, how-to, reference migration)
  • Blocked by: None (this is the foundation task)

Technical Notes

  • Review existing Hugo configuration in hugo.yaml to understand current navigation setup
  • Ensure the configured theme supports the new structure (may need to update theme configuration)
  • Test navigation menu appears correctly in both desktop and mobile views
  • Verify CI/CD pipeline (uses Netlify, configured in netlify.toml) builds successfully with new structure

Generated-by: Cursor

Metadata

Metadata

Assignees

No one assigned

    Labels

    kind/documentationCategorizes issue or PR as related to documentation.

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions