-
Notifications
You must be signed in to change notification settings - Fork 851
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Convert api/*.rst -> api/*.md via rst2myst #2035
Conversation
You opened several similar PRs. None of the gives any reasoning to the change. My comment relates to all of those. What issue does this address? What benefits does this provide? Its quite tedious work to review this, so what reasoning am I missing? |
This has been brought up in dev meetings for a while, to have 1 format for documentation everywhere, not a mixture of .rst and .md. This is actually a long overdue change; @tpike3 could confirm this. The secondary reason is I want to try ChatGPT in making the docs clearer and more concise. See #2037. I made several orthogonal PR's so that they can be reviewed piecemeal, and I have self-reviewed each myself. Where manual fixes are applied in the subsequent commits. |
Ok good, thanks for the reply. Would be good to include something like that in at least one of the PRs as a description in the future. |
@rht, please always add a PR description. Not only for us as maintainers, but also for others looking around. Structure for example it like this:
It's really important for reviews and users and contributors the PRs are accessible and as easy as possible to understand. This is not optional, however small the PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Added description. |
|
Another #1962 bus factor issue! @tpike3 or @jackiekazil could one of you remove all the required status checks? Approval by maintainers is already needed, we can interpret ourselves if the CI does what we want or not. We don't need a hard check for that. |
@EwoutH -
|
This is only visible for admins. Just for reference I added the required checks in response to #1788 (comment) But I agree we should remove them again. |
Disabled the pass status checks, I will not merge these ones to make sure there are not issues. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tested and look good to me! Thank you both!
This has been brought up in dev meetings for a while, to have 1 format for documentation everywhere, not a mixture of .rst and .md. This is actually a long overdue change; @tpike3 could confirm this. The secondary reason is I want to try ChatGPT in making the docs clearer and more concise. See #2037.