-
-
Notifications
You must be signed in to change notification settings - Fork 25.9k
DOC Update documentation: Communication section improvements #31420
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
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.
That's a nice improvement. Thank you, @adlina1!
I've only got a little nit comment on the length of the subheading marker.
And it would be great if you could add a "DOC" in front of your PR title.
For the second reviewer: I have checked that
- all the links are the same
- that
-------
-->~~~~~
-->^^^^^
is the common order to mark headings in rst files - build a preview with
python -m docutils.writers.html5_polyglot README.rst > preview.html
and checked that everything looks fine (it does)
Developer & Support | ||
^^^^^^^^^^^^^^^^^^^^^^ |
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.
Nit: These should have the same length.
Developer & Support | |
^^^^^^^^^^^^^^^^^^^^^^ | |
Developer & Support | |
^^^^^^^^^^^^^^^^^^^ |
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.
LGTM thanks!
Reference Issues/PRs
What does this implement/fix? Explain your changes.
Reorganize Communication section for better usability:
-> Group communication channels by purpose (Main Channels, Getting Help & Support, Social Media Platforms, Additional Resources)
-> Improve readability and help users quickly find the right channel for their needs
Any other comments?