Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
admclachlan opened this issue Aug 8, 2021 · 1 comment
Open
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@admclachlan
Copy link
Contributor

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 admclachlan self-assigned this Sep 27, 2024
@admclachlan admclachlan added the documentation Improvements or additions to documentation label Sep 27, 2024
@admclachlan
Copy link
Contributor Author

Can ressurect this for the new vfb connect

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant