Reorganized index.rst for improved logical flow #1054
Merged
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
This was referenced May 21, 2024
dieser-niko
approved these changes
May 21, 2024
|
@stephanebruckert how can the documentation on https://spotipy.readthedocs.io be updated? It doesn't seem to be triggered by releases, as the latest release is not in the list. Edit: Wait, readthedocs has an easy to use build pipeline and we aren't using that?.. |
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.
The goal of this restructuring is to improve the logical flow of the tutorial, making it more intuitive and easier for new users to follow.
Moved the top level examples (Birdy, Led Zeppelin, URL for an artist image given the artist's name) to the "Examples" section. This organization scheme guides a user through setup and authorization before diving into examples, which follows the logical flow of setup.
Only small edits were made to the text; link to Spotipy Tutorial for Beginners was added under "Getting Started."