Docs tweaks #591
Merged
Docs tweaks #591
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dnicolodi
force-pushed
the
docs-tweaks-4
branch
2 times, most recently
from
dfb5f9b to
7775ea5
Compare
rgommers
approved these changes
Apr 17, 2024
There was a problem hiding this comment.
Thanks @dnicolodi! I like the improvements to the front page in particular, it illustrates much better what this project is about. Just one comment about backend vs. back-end.
There is just one tutorial so a longer title just wastes real estate in the navigation bar. Even expanding the content of the tutorial to cover more concepts I do not see it growing to a length warranting splitting it into multiple pages.
This makes the documentation landing page more informative.
Use continuous tense in the title as done for other page titles in the same section. Simplify and improve wording. Update for latest pip releases.
This belongs to the more descriptive part of the documentation.
This is mostly to make the documentation index look nicer.
This documentation page does not contain much relevant information, and it suggests to use nox to build the documentation, whose AFAIK is not really used by any of the regular contributors, thus it is likely to stop working without anyone noticing.
dnicolodi
force-pushed
the
docs-tweaks-4
branch
from
ea9eded to
242b79d
Compare
|
I fixed the spelling of "backend". As the changes were otherwise approved, I'll merge this now. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm still working on updating the tutorial, but I wanted to get these changes and reorganization out for review as they are independent of the tutorial updates.