Skip to content

Potential changes to use the Diataxis framework for the docs #70

@admclachlan

Description

@admclachlan

https://diataxis.fr/

The current tutorials overlap with how-to guides, potentially the tutorials could be made into more of a project that the users are led through rather than the series of how-to guides they currently represent.

The reference already fits the framework however the overlap between the 'complete documentation' and reference is potentially confusing so that users may not be immediately sure of which to use.

The documentation currently lacks a clear explanation, from a higher level perspective for the user. The 'VFB connect API overview' section could fill this role but is currently under the tutorial section and could perhaps also be extended (curently becomes technical quickly).

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions