[Doc]: Add visual key to user guide · Issue #26205 · matplotlib/matplotlib · GitHub
Skip to content

[Doc]: Add visual key to user guide #26205

Description

@story645

Documentation Link

https://matplotlib.org/devdocs/users/index.html

Problem

It's hard to navigate the user guide if you don't know what we call things. Folks should start on the quick start so that they will learn what it's called, but a) we don't indicate that quickstart teaches that indormation, b) a lot of folks don't and we should account for that. attn: @melissawm and @esibinga

Suggested improvement

I was thinking like pull out and streamline the parts of figure part of the quickstart guide and make it a big card. Something like:

Screenshot: Sample layout

If folks like this direction, it can definitely be cleaned up to something pretty and probably slim down the anatomy figure to just the basics. Maybe take the longer descriptions from anatomy and work them into their corresponding intros.

And probably streamlined to just the contents of the userguide index if #26156 gets resolved.

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

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions