Title: [Doc]: Add visual key to user guide · Issue #26205 · matplotlib/matplotlib · GitHub
Open Graph Title: [Doc]: Add visual key to user guide · Issue #26205 · matplotlib/matplotlib
X Title: [Doc]: Add visual key to user guide · Issue #26205 · matplotlib/matplotlib
Description: 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)...
Open Graph Description: 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 ...
X Description: 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 ...
Opengraph URL: https://github.com/matplotlib/matplotlib/issues/26205
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[Doc]: Add visual key to user guide","articleBody":"### Documentation Link\r\n\r\nhttps://matplotlib.org/devdocs/users/index.html\r\n\r\n### Problem\r\n\r\nIt'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 \r\n\r\n### Suggested improvement\r\n\r\nI was thinking like pull out and streamline the [parts of figure](file:///C:/Users/story/Projects/matplotlib/doc/build/html/users/explain/quick_start.html#parts-of-a-figure) part of the quickstart guide and make it a big card. Something like: \r\n\r\n\u003cdetails open\u003e\r\n\u003csummary\u003e Screenshot: Sample layout\u003c/summary\u003e\r\n\u003cimg src=\"https://github.com/matplotlib/matplotlib/assets/1300499/890d1006-2433-4748-bf7c-bc9f73afd3a2\"\u003e\r\n\r\n\u003c/details\u003e\r\n\r\nIf 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. \r\n\r\n And probably streamlined to just the contents of the [userguide index](file:///C:/Users/story/Projects/matplotlib/doc/build/html/users/explain/index.html) if #26156 gets resolved. \r\n","author":{"url":"https://github.com/story645","@type":"Person","name":"story645"},"datePublished":"2023-06-28T19:14:59.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":15},"url":"https://github.com/26205/matplotlib/issues/26205"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:46f66571-5d12-c242-e04b-511f751d2e75 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | A4CE:378B6C:35FFCF:486301:6A51C025 |
| html-safe-nonce | 9299ea64924983ed85f9d333192c124a53f21a222e055a232a8388b8edbbb6ba |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBNENFOjM3OEI2QzozNUZGQ0Y6NDg2MzAxOjZBNTFDMDI1IiwidmlzaXRvcl9pZCI6IjU0NTQ3MzQzMjYyOTkxOTc4MSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 9c8dcbc58bb5bcd138fc3af34c315e29de4e50b6cc470e14723e6e7dbc2b7992 |
| hovercard-subject-tag | issue:1779583374 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/matplotlib/matplotlib/26205/issue_layout |
| twitter:image | https://opengraph.githubassets.com/edbf7519d50c650c52417b1629fc4de797346d759d1c2be7e0f42ae8c88a0c9d/matplotlib/matplotlib/issues/26205 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/edbf7519d50c650c52417b1629fc4de797346d759d1c2be7e0f42ae8c88a0c9d/matplotlib/matplotlib/issues/26205 |
| og:image:alt | 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 ... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | story645 |
| hostname | github.com |
| expected-hostname | github.com |
| None | b9a586c06a05a7a86fc7e3f4dbd03e42f6869085879aa184aa6369456dbd50fb |
| turbo-cache-control | no-preview |
| go-import | github.com/matplotlib/matplotlib git https://github.com/matplotlib/matplotlib.git |
| octolytics-dimension-user_id | 215947 |
| octolytics-dimension-user_login | matplotlib |
| octolytics-dimension-repository_id | 1385122 |
| octolytics-dimension-repository_nwo | matplotlib/matplotlib |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 1385122 |
| octolytics-dimension-repository_network_root_nwo | matplotlib/matplotlib |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 7aed05249554b889eb33d002851a973eebcc7e91 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width