-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
Rewrite help page section. #2821
Conversation
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.
This is pretty hard to review because of the following:
- Git is not aware of the rename of
documentation.rst
->help-pages.rst
. This makes it hard to understand what has changed because it's all "new". See https://stackoverflow.com/questions/433111/how-to-make-git-mark-a-deleted-and-a-new-file-as-a-file-move. - The sections have been re-ordered.
Could we do the following to make reviewing easier:
- Keep the order of the sections.
- Tell git of the rename.
Then a reviewer will be able to see the changes under each section.
If you still want to re-order sections, could that be done in a separate PR?
Could you also rebase this on main? |
Can do both. |
Do you want all docs based on main or just this branch? |
bf843c3
to
9ec127f
Compare
9ec127f
to
76db878
Compare
@AndreasBackx Done. |
All docs, let's focus on just main for now.
Thanks, this is much easier to review now. |
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.
I'll approve to get this out the door. Though please make the non-nit changes. I definitely like that this is easier to read and skim, less fluff.
I will make the changes. I don't think you have to worry about approving. I was able to merge without the review being fully approved on the last one. |
Co-authored-by: Andreas Backx <[email protected]>
…click into rewrite_help_pages_2
Rewrite help page generation section, formerly documenting script.