Repository navigation
Split source directory into guides and reference - #1802
Merged
Merged
Conversation
srittau
marked this pull request as ready for review
July 15, 2024 12:05
JelleZijlstra
approved these changes
Jul 15, 2024
JelleZijlstra
left a comment
Member
There was a problem hiding this comment.
Thanks! Every time I look at this repo I am confused about what "source" means.
Collaborator
Author
|
Done and redirects added. |
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
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.
This brings order into both the repository, but also the URL structure by replacing the meaningless "source" component in the URL. This also means that e.g. https://typing.readthedocs.io/en/latest/guides/ will be a guide index, instead of https://typing.readthedocs.io/en/latest/source/guides.html which then links to other documents in the "source" directory.
Depends on #1801.
DON'T MERGE, just approve please. If this gets approved, I will merge it and add redirects in the readthedocs config from the old paths to the new paths.