Skip to content

[task] Reorganize sidebar in astro.config.mjs to follow Diátaxis structure #1474

Closed as not planned

Description

@github-actions

Objective

Update the documentation sidebar configuration in docs/astro.config.mjs to follow the Diátaxis framework with four distinct sections: Tutorials, How-To Guides, Reference, and Explanation.

Context

The scout report recommends adopting the Diátaxis framework sidebar structure. This provides clear navigation pathways and helps users find the right type of documentation for their needs. Part of issue #1433.

Approach

  1. Update the sidebar: array in docs/astro.config.mjs
  2. Create four main sections with descriptive labels
  3. Map existing directories to appropriate sections
  4. Improve information scent with task-oriented labels

Current Structure

sidebar: [
  { label: 'Start Here', autogenerate: { directory: 'start-here' } },
  { label: 'Workflows', autogenerate: { directory: 'reference' } },
  { label: 'Tools', autogenerate: { directory: 'tools' } },
  { label: 'Guides', autogenerate: { directory: 'guides' } },
  { label: 'Application Areas', autogenerate: { directory: 'samples' } },
]

Target Structure

sidebar: [
  { label: 'Getting Started', autogenerate: { directory: 'start-here' } },
  { label: 'Tutorials', autogenerate: { directory: 'tutorials' } },
  { label: 'How-To Guides', autogenerate: { directory: 'how-to' } },
  { label: 'Reference', items: [
    { label: 'Workflow Configuration', autogenerate: { directory: 'reference' } },
    { label: 'CLI Tools', autogenerate: { directory: 'tools' } },
  ]},
  { label: 'Concepts', autogenerate: { directory: 'explanation' } },
  { label: 'Examples', autogenerate: { directory: 'samples' } },
]

Files to Modify

  • docs/astro.config.mjs - Update sidebar configuration only

Acceptance Criteria

  • Sidebar has clear Diátaxis sections (Tutorials, How-To, Reference, Concepts)
  • Labels use task-oriented language
  • Configuration is valid JavaScript
  • Documentation site builds successfully
  • Navigation works correctly in local preview
  • All existing pages remain accessible

Notes

  • This task focuses ONLY on the sidebar configuration
  • Do not move or create files - that will be done in separate tasks
  • Empty directories (tutorials, how-to, explanation) will show as empty sections initially
    Related to Simplify docs scaffolding #1433

AI generated by Plan Command

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions