Title: combine narrative docs and tutorials · Issue #24746 · matplotlib/matplotlib · GitHub
Open Graph Title: combine narrative docs and tutorials · Issue #24746 · matplotlib/matplotlib
X Title: combine narrative docs and tutorials · Issue #24746 · matplotlib/matplotlib
Description: Was trying to pull out just the restructuring from #24493 and every shuffle felt like it wasn't sticking and I think something a couple of us kept coming back to is that the way the narrative docs are written is conceptually almost indis...
Open Graph Description: Was trying to pull out just the restructuring from #24493 and every shuffle felt like it wasn't sticking and I think something a couple of us kept coming back to is that the way the narrative docs ...
X Description: Was trying to pull out just the restructuring from #24493 and every shuffle felt like it wasn't sticking and I think something a couple of us kept coming back to is that the way the narrative d...
Opengraph URL: https://github.com/matplotlib/matplotlib/issues/24746
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"combine narrative docs and tutorials","articleBody":"Was trying to pull out just the restructuring from #24493 and every shuffle felt like it wasn't sticking and I think something a couple of us kept coming back to is that the way the [narrative docs](https://matplotlib.org/devdocs/users/explain/index.html) are written is conceptually almost indistinguishable from the [tutorials](https://matplotlib.org/devdocs/tutorials/index.html). \r\n\r\n\u003e but I think the more fundamental issue is the awkward match between the rst docs and the tutorials/gallery; much of what is in the tutorials would more logically be called part of a Users Guide.\r\n\r\n_Originally posted by @jklymak in https://github.com/matplotlib/matplotlib/issues/24493#issuecomment-1320219606_\r\n\r\nThe tutorials and the narrative docs are both very explanatory and comprehensive, in ways where it's not clear that they're written for different audiences or purposes. I could maybe see the argument that one is written for developers and the other for users, but there's nothing in the UX to sign post that. This leads to confusion about where users should start - guide or tutorial. I also wonder if one of the reasons folks think Matplotlib doesn't provide interactivity is that all the documents explaining how to build interactive visualizations are in the user guide (and it's very unclear why they're there and not in the tutorials.) \r\n\r\n### Solution\r\n\r\nI think an easy solution is to port the [8 explanation](https://github.com/matplotlib/matplotlib/tree/main/doc/users/explain) documents to sphinx-gallery and move them to tutorials. And then possibly change the name of that section to user guides since some of the examples in the gallery border on tutorials anyway...\n\nETA: just to be clear, this needs a ton of discussion \u0026 is very much not ready for a PR.","author":{"url":"https://github.com/story645","@type":"Person","name":"story645"},"datePublished":"2022-12-16T05:35:36.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":28},"url":"https://github.com/24746/matplotlib/issues/24746"}
| 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:98f5b9b1-8291-bc71-62e9-ad8f5c4f313d |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | A33A:15F4EE:87223E:B817E2:6A529083 |
| html-safe-nonce | 16e8824a534e94052d7cb196fdb002ac473aabdf19dd40b2404b418979250405 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBMzNBOjE1RjRFRTo4NzIyM0U6QjgxN0UyOjZBNTI5MDgzIiwidmlzaXRvcl9pZCI6IjEwNzEzNTk0Mzc0ODk0NzU3MTUiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 647d1d24786b6a98ae4277884b4f52a8879075d2bb57f809a9daf83b760b7df6 |
| hovercard-subject-tag | issue:1499631387 |
| 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/24746/issue_layout |
| twitter:image | https://opengraph.githubassets.com/d7eb4758ca1176c503ac825f9c0a372134855403e73e5c3ab8adbce4632bfa5e/matplotlib/matplotlib/issues/24746 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/d7eb4758ca1176c503ac825f9c0a372134855403e73e5c3ab8adbce4632bfa5e/matplotlib/matplotlib/issues/24746 |
| og:image:alt | Was trying to pull out just the restructuring from #24493 and every shuffle felt like it wasn't sticking and I think something a couple of us kept coming back to is that the way the narrative docs ... |
| 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 | 07a982c1d40157c619b364352b704c3ce66bb332 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width