Conversation
|
Big picture sounds good, I'm gonna leave feedback in pieces:
So I'd rather keep dev workflow scoped to "how to GitHub" and prg has a lot of mpl process stuff. But also I think the bigger issue is that PRG is really two docs smushed together - a "did you follow coding guidelines?" for writers and a full on reviewing and merging guide for maintainers. So I think maybe splitting out the two might be the move: checklist either moved to top of coding guide or maybe its own page (it kinda goes w/ triage but I don't think writers will find it there) and reviewer guide moved to maintaince? |
|
Or b/c pull request checklist applies to code and docs, split so just the checklist for writers goes in workflow? |
Agreed! Will work on it. |
| Sphinx Theme | ||
| ------------ | ||
|
|
||
| Matplotlib has a few subprojects that share the same navbar and style, so these | ||
| are centralized as a sphinx theme at | ||
| `mpl_sphinx_theme <https://github.com/matplotlib/mpl-sphinx-theme>`_. Changes | ||
| to the style or top bar should be made there to propagate across all subprojects. | ||
|
|
There was a problem hiding this comment.
this is now documented in the doc docs, but maybe it should be a top level heading? https://matplotlib.org/devdocs/devel/document.html#theme
There was a problem hiding this comment.
This is exactly that section, I just moved it here. My rationale is that this is a different way to contribute we could highlight here:
By top-level heading, do you mean it should be next to "Ways to contribute" or next to "Style guide", for example?
There was a problem hiding this comment.
By top level I mean not under a subheading in the docs guide. I think it's a little too specific for the broader contribution guide - like is there someone who'd be into this type of contribution who wouldn't read the docs guide?
There was a problem hiding this comment.
I see what you mean - I don't have a strong opinion here, so would be fine to leave as is.
| If you started making changes on your local ``main`` branch, you can convert the | ||
| branch to a feature branch by renaming it:: | ||
|
|
||
| git branch -m <newname> |
There was a problem hiding this comment.
not sure if it'd be helpful to keep this somewhere
There was a problem hiding this comment.
My reasoning for these changes was to leave only the most essential git guidance here, or anything that is Matplotlib-specific. For general git tips and tricks, trust that the reader can search elsewhere. This is to avoid redundancy and outdated information, but also to tighten documentation scope. This specific one is 3 lines long so I don't mind keeping if we do feel strongly about it, though.
There was a problem hiding this comment.
Nah that's fine, your reasoning makes sense and "it's only 3 lines" is how we snowball
|
did not know you could do this, very much 😍 |
2 participants
PR summary
Reorganization of devdocs, building on matplotlib#26392, matplotlib#28578, matplotlib#26196.
This PR won't be submitted to matplotlib as a whole block, but broken up into different smaller parts. I wanted to build it like this to see if the final product would make sense.
Items changed:
Not sure if I succeeded completely, but the goal is:
Other minor changes:
Screenshots for reference
AI Disclosure
No AI
PR quality check