Skip to content
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

Merged
merged 6 commits into from
Jul 18, 2024
Merged

Moved documentation to docs directory #1474

merged 6 commits into from
Jul 18, 2024

Conversation

svengregorio
Copy link
Contributor

@svengregorio svengregorio commented Jul 11, 2024

Fixes #1479

  • I have added a news fragment under 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

@svengregorio
Copy link
Contributor Author

Apparently fixing the link for Github, breaks it for nox. This may need to become an issue instead of a PR.

@uranusjr
Copy link
Member

The link target is a symlink, problem is GitHub’s code viewer does not support that…

@dukecat0
Copy link
Member

Or perhaps we can simply change it to https://pipx.pypa.io/stable/installation/#using-pipx-with-pre-commit?

@Gitznik
Copy link
Contributor

Gitznik commented Jul 15, 2024

Or perhaps we can simply change it to https://pipx.pypa.io/stable/installation/#using-pipx-with-pre-commit?

This would be very confusing when looking at the docs on not stable. E.g. clicking the link on the latest docs would redirect you to the stable docs.

@svengregorio
Copy link
Contributor Author

svengregorio commented Jul 15, 2024

According to GitHub's README documentation, README.md could be in the docs directory, eliminating the need for symlinks. I could test whether this approach truly works in the next days.

@svengregorio
Copy link
Contributor Author

I retroactively opened issue #1479 for this PR, I hope this doesn't cause any confusion.

@svengregorio svengregorio changed the title Fixed broken link in README.md Moved documentation to docs directory Jul 16, 2024
@dukecat0 dukecat0 merged commit 832c3fa into pypa:main Jul 18, 2024
11 checks passed
@svengregorio svengregorio deleted the patch-1 branch July 18, 2024 05:42
@svengregorio svengregorio restored the patch-1 branch July 18, 2024 05:42
@svengregorio svengregorio deleted the patch-1 branch July 18, 2024 05:42
chrysle pushed a commit that referenced this pull request Sep 11, 2024
* 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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Symlinks in GitHub's markdown viewer are broken
5 participants