Skip to content

[Docs] Make Quick Start section easier to read #452

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

Merged

Conversation

bittner
Copy link
Contributor

@bittner bittner commented Jan 24, 2017

The current docs contain the essential in the introduction paragraph, but they're a bit hard to read. Let's make it super-easy, legible and beautiful to help reduce the drop-off rate for newcomers!

  • Make Quick Start section easier to read for developers
  • Move table of contents down, promote the "Why use it?" section
  • Use Title Case (almost) uniformly

Reorder sections (table of contents at the end)

Use Title Case in (most) titles
@bittner
Copy link
Contributor Author

bittner commented Jan 28, 2017

The build on Travis CI has failed for infrastructure issues (obviously), unrelated to the changes.

Would be nice if we could merge the changes to further update the docs. Cheers!

@pelme pelme merged commit 283afbd into pytest-dev:master Jan 29, 2017
@pelme
Copy link
Member

pelme commented Jan 29, 2017

Again, very very nice! :) Thanks!

mfa pushed a commit to aexeagmbh/pytest-django that referenced this pull request May 17, 2017
Reorder sections (table of contents at the end)

Use Title Case in (most) titles
timb07 pushed a commit to timb07/pytest-django that referenced this pull request May 26, 2018
Reorder sections (table of contents at the end)

Use Title Case in (most) titles
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants