Skip to content

Reorganize by diataxis #245

@jordanstephens

Description

@jordanstephens

Diataxis lays out four quadrants of documentation:

  • Tutorials (learning oriented)
  • How-to Guides (goal oriented)
  • Explanation (understanding oriented)
  • Reference (information oriented)

We have two primary sections:

  • "Tutorials"
  • "Concepts"
  • Let's rename "Tutorials" as "Guides"
  • Let's create a new "Tutorials" section with the "Getting started" article
    • Let's also create a "Tutorial" for all of the youtube videos that Raph has been doing
  • Let's break up "Concepts" into "Reference" and "Explanation". Most of these articles are probably "Reference", but some of them could probably be moved into "Explanation"

Here's an article on the difference between Tutorial and Guide: https://diataxis.fr/tutorials-how-to/
And another on the difference between Explanation and Reference: https://diataxis.fr/reference-explanation/

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions