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

docs: updated installation guides #1989

Merged
merged 4 commits into from
Jan 2, 2025
Merged

docs: updated installation guides #1989

merged 4 commits into from
Jan 2, 2025

Conversation

pd93
Copy link
Member

@pd93 pd93 commented Jan 2, 2025

Standardises the layout for all installation methods, adds labels and links to sources where possible. Also reorders the list with the official methods at the top and community owned ones at the bottom.

Also closes #935.

@pd93 pd93 requested review from andreynering and vmaerten and removed request for andreynering January 2, 2025 14:38
Copy link
Member

@vmaerten vmaerten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏

Copy link
Member

@andreynering andreynering left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, this page needed an overhaul 👏

The only small thing I noticed that would be nice to fix if easy, is that link anchors for the titles that have badges now have extra dashes:

image

This means that existing links for these anchors will be broken, and new links will look slightly uglier.

@pd93 pd93 force-pushed the updated-installation-docs branch from 080b1ab to b6b0dd4 Compare January 2, 2025 17:47
@pd93
Copy link
Member Author

pd93 commented Jan 2, 2025

link anchors for the titles that have badges now have extra dashes:

Yeah, I noticed this just as you commented! Thankfully Docusaurus allows you to manually set the anchor ids, so I have updated them all to match the previous values now.

I have also added the pypi package as discussed in #935.

@pd93 pd93 requested a review from andreynering January 2, 2025 17:49
@pd93 pd93 merged commit 27de441 into main Jan 2, 2025
14 checks passed
@pd93 pd93 deleted the updated-installation-docs branch January 2, 2025 18:20
pd93 added a commit that referenced this pull request Jan 2, 2025
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.

Publish task as a Python package
3 participants