search

VirtualFlyBrain / VFB_connect

A library for querying VFB servers (neo4j, owlery, solr)
GNU General Public License v3.0
4 stars 1 forks source link

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

Open admclachlan opened 3 years ago

admclachlan commented 3 years ago

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).

admclachlan commented 2 weeks ago

Can ressurect this for the new vfb connect