Skip to content

Rework documentation to be task-oriented with Astro templates for shared content #1179

@naomi-freecodecamp

Description

@naomi-freecodecamp

Description

Currently, our documentation is structured in a more traditional format. We should rework it to be more task-oriented and user-focused, following a "If you want to contribute X, follow these steps" approach.

Proposed Changes

1. Task-Oriented Structure

Restructure documentation to focus on contributor goals:

  • "If you want to fix a bug, follow these steps"
  • "If you want to add a new feature, follow these steps"
  • "If you want to improve documentation, follow these steps"
  • "If you want to translate content, follow these steps"
  • etc.

2. Leverage Astro Templates

Use Astro's templating capabilities to create reusable components for common shared information:

  • Repository setup instructions (cloning, dependencies, etc.)
  • PR submission process
  • Code review guidelines
  • Testing requirements
  • Common troubleshooting steps

This approach will:

  • Reduce duplication - Shared content maintained in one place
  • Improve consistency - Same instructions shown everywhere they're needed
  • Easier maintenance - Update once, reflected everywhere
  • Better UX - Contributors find exactly what they need for their specific goal

Benefits

  • More intuitive - Contributors can quickly find instructions for their specific contribution type
  • Less repetition - Common setup/process info templated and reused
  • Easier to maintain - Changes to shared processes only need updating in one place
  • Scalable - Easy to add new contribution types without duplicating setup instructions

Implementation Notes

This would involve:

  1. Auditing current documentation to identify common/repeated content
  2. Creating Astro component templates for shared content
  3. Restructuring docs into task-oriented pages
  4. Updating navigation to reflect the new structure

Would appreciate feedback on this approach before implementation!

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