Expand the overview section of the docs #3158
Draft
+45 −30
Conversation
This file contains hidden or 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
🔍 Preview links for changed docs |
miguelgrinberg force-pushed the docs-overview branch from 878a17b to eea6f06 Compare miguelgrinberg force-pushed the docs-overview branch from eea6f06 to 017679a Compare miguelgrinberg force-pushed the docs-overview branch 2 times, most recently from 43b64ab to 42d4f3e Compare miguelgrinberg force-pushed the docs-overview branch from 42d4f3e to 6324a7a Compare miguelgrinberg force-pushed the docs-overview branch from 6324a7a to 7fb50fd Compare miguelgrinberg force-pushed the docs-overview branch from 7fb50fd to 0949b58 Compare miguelgrinberg force-pushed the docs-overview branch from 0949b58 to 221d83c Compare Contributor Author
| @marciw @pquentin Looking for early feedback on this reordering and expansion of the content in the overview page of the docs. I want to make it more clear that there are a number of somewhat independent things all included in this package, so I'm enumerating the four big components, each with links to its high level and reference docs. Let me know what you think, or if you have suggestions to improve this. Thanks! |
miguelgrinberg force-pushed the docs-overview branch from 221d83c to e8c9c8e Compare miguelgrinberg force-pushed the docs-overview branch from e8c9c8e to c5a68f4 Compare miguelgrinberg force-pushed the docs-overview branch from c5a68f4 to b8a5a3e Compare miguelgrinberg force-pushed the docs-overview branch from b8a5a3e to 41b8ef2 Compare 
Member
| This brings a lot of clarity, thank you! I'd still like to see a code example above the fold, maybe not as a REPL session. I've seen user interviews where users in a hurry don't read anything, but copy/paste the first text snippet they see and try to adapt it to their needs. |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
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.
No description provided.