Skip to content

Kinds of Documentation #8

Open
Open
@kazk

Description

@kazk

We should write documentation with purpose and target audience in mind.

docs/data/kinds.yml

Lines 9 to 36 in 409a7cd

# keywords: lesson, newcomer, get started
- id: tutorial
name: Tutorials
description: ""
path: /tutorials/
# keywords: how to, problem oriented, one goal
- id: recipe
name: Recipes
description: ""
path: /recipes/
# keywords: describe, list, brief
- id: reference
name: References
description: ""
path: /references/
# keywords: explain, why, concepts, background, discussion, further reading
- id: explanation
name: Explanations
description: ""
# Similar to Recipes, but focused on providing a copy pastable code.
# Recipes can link to these to provide alternative solutions.
- id: snippet
name: Snippets
description: ""

The documentation system

Reference: https://documentation.divio.com/

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions