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: Add dedicated issues section to the installation page #3321

Conversation

acheroncrypto
Copy link
Collaborator

Problem

The installation page has been getting longer recently, which could scare new people off.

One easy way we can make the installation page shorter is to create a dedicated "Issues" section instead of mentioning them during the installation. For example, #3272 added a potential issue with the Rust installation, but even though the vast majority of people won't run into that specific issue, it still takes a lengthy space inside the main installation section.

Summary of changes

  • Add dedicated issues section to the installation page
  • Add "Incorrect $PATH" as the first issue

Copy link

vercel bot commented Oct 19, 2024

@acheroncrypto is attempting to deploy a commit to the coral-xyz Team on Vercel.

A member of the Team first needs to authorize it.

@acheroncrypto acheroncrypto added the documentation Improvements or additions to documentation label Oct 19, 2024
@acheroncrypto acheroncrypto merged commit 7edc3c9 into coral-xyz:master Oct 19, 2024
0 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant