René's URL Explorer Experiment


Title: [Doc]: Sort out doc mechanics/formatting/content guides · Issue #26392 · matplotlib/matplotlib · GitHub

Open Graph Title: [Doc]: Sort out doc mechanics/formatting/content guides · Issue #26392 · matplotlib/matplotlib

X Title: [Doc]: Sort out doc mechanics/formatting/content guides · Issue #26392 · matplotlib/matplotlib

Description: Documentation Link No response Problem We have these two documentation guides where the write docs page is a mix of "how to build", and formatting and content guidelines and the "style guide" mixes formatting and content: https://matplot...

Open Graph Description: Documentation Link No response Problem We have these two documentation guides where the write docs page is a mix of "how to build", and formatting and content guidelines and the "style guide" mixes...

X Description: Documentation Link No response Problem We have these two documentation guides where the write docs page is a mix of "how to build", and formatting and content guidelines and the "sty...

Opengraph URL: https://github.com/matplotlib/matplotlib/issues/26392

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[Doc]: Sort out doc mechanics/formatting/content guides","articleBody":"### Documentation Link\n\n_No response_\n\n### Problem\n\nWe have these two documentation guides where the write docs page is a mix of \"how to build\", and formatting and content guidelines and the \"style guide\" mixes formatting and content:\r\n\r\n* https://matplotlib.org/devdocs/devel/document.html\r\n* https://matplotlib.org/devdocs/devel/style_guide.html\r\n\n\n### Suggested improvement\n\nBuild related docs should go on a different page from formatting and content related guides. The content is of a different type and scope and separating it out will down the line help us surface it more cleanly in TOCs, sidebars, and the like and give us more flex if we decide it belongs in workflow rather than guidelines. \r\n\r\nI also think we should separate out formatting from content guidelines. The major reason is that the general formatting guidelines apply to all the docs regardless of what type, while content specific guides are specific to docstrings/examples/tutorials/user guide and seperating this out may make it easier to communicate that. It will also allow us to reduce some of the replication we're currently seeing across the style and writing guides. My bias is to put each set of content guidelines on its own page (so like \"docstring content guidelines\") in a docsdoc/content folder but that's mostly b/c of my preference for small scoped docs pages.  \r\n\r\nSomewhat inspired by @esibinga's GSOD work and trying to figure out where to put it. ","author":{"url":"https://github.com/story645","@type":"Person","name":"story645"},"datePublished":"2023-07-26T18:49:08.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/26392/matplotlib/issues/26392"}

route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:b948e7c1-2e9b-e1bf-04f6-d70795cd5d96
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-id9F48:4342D:F4F35A:146BB73:6A52919F
html-safe-nonce42e7288213e1e59f12d10b481852c5f80297a67b29ca071cab7fc245c175e410
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5RjQ4OjQzNDJEOkY0RjM1QToxNDZCQjczOjZBNTI5MTlGIiwidmlzaXRvcl9pZCI6IjE3NzA4MjU1NjYzNjQyNzUxMDMiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmac3e96ec573634151b48f3efc94e595399d264e2032ef205c7d971e53a34327595
hovercard-subject-tagissue:1822971958
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/matplotlib/matplotlib/26392/issue_layout
twitter:imagehttps://opengraph.githubassets.com/85178b085ae1fbd0897c71ae90882c2a7dc58b4bdafc236663754fd5093b58b4/matplotlib/matplotlib/issues/26392
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/85178b085ae1fbd0897c71ae90882c2a7dc58b4bdafc236663754fd5093b58b4/matplotlib/matplotlib/issues/26392
og:image:altDocumentation Link No response Problem We have these two documentation guides where the write docs page is a mix of "how to build", and formatting and content guidelines and the "style guide" mixes...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamestory645
hostnamegithub.com
expected-hostnamegithub.com
Noneb9a586c06a05a7a86fc7e3f4dbd03e42f6869085879aa184aa6369456dbd50fb
turbo-cache-controlno-preview
go-importgithub.com/matplotlib/matplotlib git https://github.com/matplotlib/matplotlib.git
octolytics-dimension-user_id215947
octolytics-dimension-user_loginmatplotlib
octolytics-dimension-repository_id1385122
octolytics-dimension-repository_nwomatplotlib/matplotlib
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id1385122
octolytics-dimension-repository_network_root_nwomatplotlib/matplotlib
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release07a982c1d40157c619b364352b704c3ce66bb332
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/matplotlib/matplotlib/issues/26392#start-of-content
https://github.com/
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmatplotlib%2Fmatplotlib%2Fissues%2F26392
GitHub CopilotWrite better code with AIhttps://github.com/features/copilot
GitHub Copilot appDirect agents from issue to mergehttps://github.com/features/ai/github-app
MCP RegistryNewIntegrate external toolshttps://github.com/mcp
ActionsAutomate any workflowhttps://github.com/features/actions
CodespacesInstant dev environmentshttps://github.com/features/codespaces
IssuesPlan and track workhttps://github.com/features/issues
Code ReviewManage code changeshttps://github.com/features/code-review
GitHub Advanced SecurityFind and fix vulnerabilitieshttps://github.com/security/advanced-security
Code securitySecure your code as you buildhttps://github.com/security/advanced-security/code-security
Secret protectionStop leaks before they starthttps://github.com/security/advanced-security/secret-protection
Why GitHubhttps://github.com/why-github
Documentationhttps://docs.github.com
Bloghttps://github.blog
Changeloghttps://github.blog/changelog
Marketplacehttps://github.com/marketplace
View all featureshttps://github.com/features
Enterpriseshttps://github.com/enterprise
Small and medium teamshttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
App Modernizationhttps://github.com/solutions/use-case/app-modernization
DevSecOpshttps://github.com/solutions/use-case/devsecops
DevOpshttps://github.com/solutions/use-case/devops
CI/CDhttps://github.com/solutions/use-case/ci-cd
View all use caseshttps://github.com/solutions/use-case
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
View all industrieshttps://github.com/solutions/industry
View all solutionshttps://github.com/solutions
AIhttps://github.com/resources/articles?topic=ai
Software Developmenthttps://github.com/resources/articles?topic=software-development
DevOpshttps://github.com/resources/articles?topic=devops
Securityhttps://github.com/resources/articles?topic=security
View all topicshttps://github.com/resources/articles
Customer storieshttps://github.com/customer-stories
Events & webinarshttps://github.com/resources/events
Ebooks & reportshttps://github.com/resources/whitepapers
Business insightshttps://github.com/solutions/executive-insights
GitHub Skillshttps://skills.github.com
Documentationhttps://docs.github.com
Customer supporthttps://support.github.com
Community forumhttps://github.com/orgs/community/discussions
Trust centerhttps://github.com/trust-center
Partnershttps://github.com/partners
View all resourceshttps://github.com/resources
GitHub SponsorsFund open source developershttps://github.com/open-source/sponsors
Security Labhttps://securitylab.github.com
Maintainer Communityhttps://maintainers.github.com
Acceleratorhttps://github.com/open-source/accelerator
GitHub Starshttps://stars.github.com
Archive Programhttps://archiveprogram.github.com
Topicshttps://github.com/topics
Trendinghttps://github.com/trending
Collectionshttps://github.com/collections
Enterprise platformAI-powered developer platformhttps://github.com/enterprise
GitHub Advanced SecurityEnterprise-grade security featureshttps://github.com/security/advanced-security
Copilot for BusinessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Pricinghttps://github.com/pricing
Search syntax tipshttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
documentationhttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmatplotlib%2Fmatplotlib%2Fissues%2F26392
Sign up https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=matplotlib%2Fmatplotlib
Reloadhttps://github.com/matplotlib/matplotlib/issues/26392
Reloadhttps://github.com/matplotlib/matplotlib/issues/26392
Reloadhttps://github.com/matplotlib/matplotlib/issues/26392
Please reload this pagehttps://github.com/matplotlib/matplotlib/issues/26392
matplotlib https://github.com/matplotlib
matplotlibhttps://github.com/matplotlib/matplotlib
Please reload this pagehttps://github.com/matplotlib/matplotlib/issues/26392
Notifications https://github.com/login?return_to=%2Fmatplotlib%2Fmatplotlib
Fork 8.4k https://github.com/login?return_to=%2Fmatplotlib%2Fmatplotlib
Star 23k https://github.com/login?return_to=%2Fmatplotlib%2Fmatplotlib
Code https://github.com/matplotlib/matplotlib
Issues 1.1k https://github.com/matplotlib/matplotlib/issues
Pull requests 408 https://github.com/matplotlib/matplotlib/pulls
Actions https://github.com/matplotlib/matplotlib/actions
Projects https://github.com/matplotlib/matplotlib/projects
Wiki https://github.com/matplotlib/matplotlib/wiki
Security and quality 0 https://github.com/matplotlib/matplotlib/security
Insights https://github.com/matplotlib/matplotlib/pulse
Code https://github.com/matplotlib/matplotlib
Issues https://github.com/matplotlib/matplotlib/issues
Pull requests https://github.com/matplotlib/matplotlib/pulls
Actions https://github.com/matplotlib/matplotlib/actions
Projects https://github.com/matplotlib/matplotlib/projects
Wiki https://github.com/matplotlib/matplotlib/wiki
Security and quality https://github.com/matplotlib/matplotlib/security
Insights https://github.com/matplotlib/matplotlib/pulse
#28578https://github.com/matplotlib/matplotlib/pull/28578
[Doc]: Sort out doc mechanics/formatting/content guideshttps://github.com/matplotlib/matplotlib/issues/26392#top
#28578https://github.com/matplotlib/matplotlib/pull/28578
Documentationhttps://github.com/matplotlib/matplotlib/issues?q=state%3Aopen%20label%3A%22Documentation%22
Documentation: devdocsfiles in doc/develhttps://github.com/matplotlib/matplotlib/issues?q=state%3Aopen%20label%3A%22Documentation%3A%20devdocs%22
https://github.com/story645
story645https://github.com/story645
on Jul 26, 2023https://github.com/matplotlib/matplotlib/issues/26392#issue-1822971958
https://matplotlib.org/devdocs/devel/document.htmlhttps://matplotlib.org/devdocs/devel/document.html
https://matplotlib.org/devdocs/devel/style_guide.htmlhttps://matplotlib.org/devdocs/devel/style_guide.html
@esibingahttps://github.com/esibinga
Documentationhttps://github.com/matplotlib/matplotlib/issues?q=state%3Aopen%20label%3A%22Documentation%22
Documentation: devdocsfiles in doc/develhttps://github.com/matplotlib/matplotlib/issues?q=state%3Aopen%20label%3A%22Documentation%3A%20devdocs%22
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.