Skip to content

docs: clarify Rust 1.89.0 requirement and add dependency-patch warning - #32

Open
Digitalenergyllc wants to merge 5 commits into
solana-foundation:mainfrom
Digitalenergyllc:fix/issue-22-rust-version
Open

docs: clarify Rust 1.89.0 requirement and add dependency-patch warning#32
Digitalenergyllc wants to merge 5 commits into
solana-foundation:mainfrom
Digitalenergyllc:fix/issue-22-rust-version

Conversation

@Digitalenergyllc

@Digitalenergyllc Digitalenergyllc commented Apr 6, 2026

Copy link
Copy Markdown
Contributor

Closes #22
Closes #20

Summary

The NCN README pins Rust 1.89.0 as a prerequisite but doesn't explain why, and the troubleshooting section didn't warn that some workarounds modify dependency source code.

Changes

  • Added a note explaining the 1.89.0 requirement (dependency versions pinned by jito-tip-router and the Solana SDK; older toolchains fail to compile), with a rustup override tip to avoid changing the system default
  • Added a warning to Troubleshooting that source-level dependency patches are fragile, lost on cargo update, and unsuitable for production (consolidated from docs: add warning about source-level dependency patches in troublesho… #33)

Closes solana-foundation#22

The prerequisites listed Rust 1.89.0-dev without explaining why a
nightly toolchain is required. Added context about jito-tip-router
and Solana SDK nightly feature dependencies.
@vercel

vercel Bot commented Apr 6, 2026

Copy link
Copy Markdown

@Digitalenergyllc is attempting to deploy a commit to the Solana Foundation Team on Vercel.

A member of the Team first needs to authorize it.

…oting

Closes solana-foundation#20

The troubleshooting section recommends commenting out code in
jito-solana dependency crates without noting that these are fragile
workarounds. Added a warning that they are for dev/testing only.
@greptile-apps

greptile-apps Bot commented Jul 12, 2026

Copy link
Copy Markdown

Greptile Summary

This PR improves the ncn/README.md with two documentation additions: a brief explanation of why Rust 1.89.0 is required (dependency pinning by jito-tip-router and the Solana SDK), and a warning blockquote at the top of the Troubleshooting section flagging that some workarounds involve fragile source modifications to dependency crates.

  • Added a prose note after the Rust install commands explaining the 1.89.0 version pin and offering rustup override as an alternative to a global default change.
  • Added a ⚠️ Warning blockquote before the Troubleshooting subsections, cautioning readers that dependency-patch workarounds are fragile and unsuitable for production.

Confidence Score: 5/5

Safe to merge — documentation-only change with no functional code modified.

Both additions are accurate, well-scoped prose changes to a README. The Rust version explanation correctly describes the pinned dependency requirement, the rustup override alternative is valid, and the troubleshooting warning accurately characterises the risk of patching dependency source. No logic, configuration, or build files are touched.

No files require special attention.

Important Files Changed

Filename Overview
ncn/README.md Documentation-only additions: explanatory note about Rust 1.89.0 version pin and a production-safety warning blockquote in the Troubleshooting section. Both additions are accurate and well-placed.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User reads ncn/README.md] --> B{Rust 1.89.0 installed?}
    B -- No --> C[rustup toolchain install 1.89.0]
    C --> D{Change global default?}
    D -- Yes --> E[rustup default 1.89.0]
    D -- No --> F[rustup override set 1.89.0\nin repo directory]
    E --> G[cargo build]
    F --> G
    B -- Yes --> G
    G --> H{Dependency conflicts?}
    H -- Yes --> I[⚠️ Warning: workarounds are fragile\nnot for production]
    I --> J[cargo update -p package --precise version\nor other pinning commands]
    J --> G
    H -- No --> K[Build succeeds]
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A[User reads ncn/README.md] --> B{Rust 1.89.0 installed?}
    B -- No --> C[rustup toolchain install 1.89.0]
    C --> D{Change global default?}
    D -- Yes --> E[rustup default 1.89.0]
    D -- No --> F[rustup override set 1.89.0\nin repo directory]
    E --> G[cargo build]
    F --> G
    B -- Yes --> G
    G --> H{Dependency conflicts?}
    H -- Yes --> I[⚠️ Warning: workarounds are fragile\nnot for production]
    I --> J[cargo update -p package --precise version\nor other pinning commands]
    J --> G
    H -- No --> K[Build succeeds]
Loading

Reviews (2): Last reviewed commit: "Update ncn/README.md" | Re-trigger Greptile

Comment thread ncn/README.md Outdated
Comment thread ncn/README.md
@Digitalenergyllc Digitalenergyllc changed the title docs: explain Rust 1.89.0 nightly requirement in NCN README docs: clarify Rust 1.89.0 requirement and add dependency-patch warning Jul 12, 2026
Digitalenergyllc and others added 2 commits July 12, 2026 04:36
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
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.

docs: Rust 1.89.0 requirement lacks explanation docs: troubleshooting section recommends source-level patches to dependencies

1 participant