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

Documentation improvements #293

Open
4 tasks
SolarDrew opened this issue Aug 10, 2023 · 1 comment
Open
4 tasks

Documentation improvements #293

SolarDrew opened this issue Aug 10, 2023 · 1 comment
Assignees
Labels
Documentation docs docs docs
Milestone

Comments

@SolarDrew
Copy link
Contributor

The docs are laid out roughly in accordance with the diataxis philsophy. There are a few places where this could be better, and a few where coverage of important topics can be improved. A non-exhaustive list:

  • remove extraneous explanation and side-quests from the tutorials to give a more focused flow
  • move those extra bits of explanation into the topic guides section
  • add a "Working with a VBI Dataset" tutorial
  • add a How-To Guides section
@SolarDrew SolarDrew added the Documentation docs docs docs label Aug 10, 2023
@SolarDrew SolarDrew added this to the v1.1.0 milestone Aug 10, 2023
@Cadair
Copy link
Member

Cadair commented Aug 11, 2023

Also adding some more short specific example like tutorials, starting with what we did on the last day of the workshop would be good.

@SolarDrew SolarDrew self-assigned this Aug 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation docs docs docs
Projects
Status: Usability
Development

No branches or pull requests

2 participants