Skip to content
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

Improved structure of Contributing Guide start page. #17549

Merged
merged 1 commit into from
Nov 30, 2023

Conversation

marksweb
Copy link
Contributor

@marksweb marksweb commented Nov 29, 2023

As has been discussed on discord, this page is difficult for some people to read. So this creates headings out of the different contributing sections rather than the definition list that is currently generated from the current format.

Vissually this is what we got rendered previously;

Screenshot 2023-11-29 at 12 00 24

And with this change, the clearer headings and the ToC entries;

Screenshot 2023-11-29 at 16 02 43

@marksweb marksweb marked this pull request as draft November 29, 2023 15:14
@marksweb marksweb marked this pull request as ready for review November 29, 2023 16:03
@felixxm felixxm changed the title docs: Improve contributing page layout Improved structure of Contributing Guide start page. Nov 30, 2023
@felixxm
Copy link
Member

felixxm commented Nov 30, 2023

@marksweb Thanks 👍 Welcome aboard ⛵

@felixxm felixxm merged commit 6ab0f8a into django:main Nov 30, 2023
27 checks passed
@marksweb marksweb deleted the docs/contributing-headings branch November 30, 2023 11:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants