-
Notifications
You must be signed in to change notification settings - Fork 443
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
Moved documentation to docs
directory
#1474
Conversation
Apparently fixing the link for Github, breaks it for |
The link target is a symlink, problem is GitHub’s code viewer does not support that… |
Or perhaps we can simply change it to |
This would be very confusing when looking at the docs on not |
According to GitHub's README documentation, |
I retroactively opened issue #1479 for this PR, I hope this doesn't cause any confusion. |
docs
directory
* Fix `/changelog/` and `/contributing/` docs URLs PR #1474 moved the docs to the `docs/` directory, and also changed casing of some filenames. - `docs/changelog.md` -> `docs/CHANGELOG.md` - `docs/contributing.md` -> `docs/CONTRIBUTING.md` This changed URL path parameters as well. URL paths to these pages must now be uppercased when accessing the deployed docs (#1540). For example, navigating to https://pipx.pypa.io/stable/CONTRIBUTING/ shows the correct page, but navigating to https://pipx.pypa.io/stable/contributing/ displays a (poorly styled) `404` page. This commit will move the pages back to `docs/changelog.md` and `docs/contributing.md` to restore the previous URLs to these pages. Note that the casing changes to not affect the homepage because MkDocs automatically handles `README.md` as `index.md`. https://www.mkdocs.org/user-guide/writing-your-docs/#index-pages * Categorize Towncrier changelog fragment as `doc` #1541 (comment)
Fixes #1479
changelog.d/
(if the patch affects the end users)Summary of changes
Moved repository documentation in the
docs
directory, so that both GitHub's markdown viewer and the official documentation can follow links in the markdown documentation.Test plan
Tested by clicking on the repaired link in the Use with pre-commit section