Skip to content

Docs improvements #61

@pattonw

Description

@pattonw

Docs have been updated, but there are still some improvements to be made that I didn't get to yet that I am leaving for future work:
Some unaddressed comments from @cmalinmayor on #60 and things I think could be improved

  • We have 3 different tutorials (quick start, in depth, benchmarks) with somewhat awkward transitions. This could be improved
  • Improve Dask vs Daisy section. It is currently sort of hidden in the middle of the in depth tutorial. This should potentially be pulled out into its own thing and placed somewhere more intuitive. Potentially between the quick start and in depth tutorial.
  • task chaining animation can be confusing if you understand the highlighted blocks as "in progress" since then the blue task would be using data from green "in progress" blocks. The highlighted blocks currently visualize the process of scheduling a block and thus move to highlight the block being processed, but continues to highlight a block after processing until a new block is sent.
  • Clear/Concise/Consistent headings and sub headings. Some of our headings provide more detail than is necessary making the navigation dropdown a bit awkward.
  • Linking between the quick start and relevant sections of the in depth tutorial for more detail.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions