Skip to content

Blog post about the docs revamp and accessibility #35

Description

@TimMonko

There were many resources I found helpful while updating the docs. So much so, that I'd like to combine the thought process I've been using (and we've used as a team since like ~July (SciPy) last year) to improve the flow -- what we've done and where we'd like to head.

Additional highlight suggestion for all the docs work that has been a part of this release:


Docs accessibility revamp

0.7.1 continued efforts to improve the documentation for accessibility and usability. The most obvious change is a new facelift to the homepage, including a new (reproducible!) video, improved information hierarchy, and highlighted examples.

Speaking of examples, you'll see improvements to the gallery examples to make drag'n'drop a better experience. You'll more easily be able to drag the .py download link directly onto the napari viewer to run our examples. Also, if an example requires a package that is not part of the "typical" napari download, then an admonition now provides instructions. Check out the affine transforms 3D example to see the new changes.

For accessibility, the search bar is now consistently available in the navbar and includes search-as-you-type. There are also now "sticky" version banners to make non-stable links from search engines or old resources more obvious that the documentation is not for the current napari version. We've also added an "Edit on Github" link to the secondary sidebar to encourage fixes and contribution to our docs!

Originally posted by @TimMonko in napari/docs#1041 (review)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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