[Doc]: rearchitecture dev docs · Issue #26196 · matplotlib/matplotlib · GitHub
Skip to content

[Doc]: rearchitecture dev docs #26196

Description

@story645

Documentation Link

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

Problem

#26086 puts in a new landing page to make contributing information more discoverable, but is relying on a lot of hand tweaking of links because the contribution docs have a lot of repetition and information at sometimes random seeming level and inconsistency about the scope of the page/section.

Suggested improvement

The docs should be reorganized + consolidated so that that page can pull from tocs. I think the top level bins on that page are the standard stages of contribution, as described by @rcomer #26086 (comment)

  • contribute: what can I contribute and help! I'm lost
  • setup how do I setup my environment? how do i make a pull request?
  • policies: I've written something, what rules do these folks have for what it needs to look like?

To match this structure, I think it's gonna require the following:

My preference for consolidation is actually to make folders under devel for at least code and doc (and probably triage) and make a bunch of smaller files for each of the standalone topics & then write a doc against that in an index file that then populates each box. Mostly cause I think it's easier to find docs when developing when they're standalone and not subsections of larger docs.

xref: #22866

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

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions