Skip to content

Update README.md#2

Open
dewana-sl wants to merge 1 commit into
KittenML:mainfrom
dewana-sl:patch-1
Open

Update README.md#2
dewana-sl wants to merge 1 commit into
KittenML:mainfrom
dewana-sl:patch-1

Conversation

@dewana-sl
Copy link
Copy Markdown

Removed the top disclaimers

Removed the top disclaimers
@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented May 23, 2026

Greptile Summary

This PR removes three top-level blockquote callouts from README.md: a developer-preview stability disclaimer, a note on browser vs. Node.js storage behaviour, and guidance on ONNX Runtime wasm CDN loading including the ortWasmPath override option.

  • The developer-preview warning is gone — if the API is not yet stable, downstream consumers will no longer be alerted that breaking changes can occur between releases.
  • The ortWasmPath CDN-override guidance has been deleted without being relocated, which removes the only hint in the docs that wasm assets are CDN-loaded by default and can be self-hosted for production or air-gapped environments.

Confidence Score: 4/5

Documentation-only change with no risk to runtime behaviour; the main concern is whether consumers lose important stability or configuration context.

All deleted content is documentation. The developer-preview disclaimer removal is worth a second look if the library's API isn't yet stable, and the ortWasmPath CDN guidance is non-obvious enough that removing it without relocation could leave production users without a critical configuration hint.

README.md — specifically whether the developer-preview status is still accurate and whether the ONNX Runtime CDN/self-hosting guidance should be preserved elsewhere in the docs.

Important Files Changed

Filename Overview
README.md Removed three blockquote callouts: the developer-preview stability warning, the browser/Node storage model note, and the CDN/self-hosting guidance for ONNX Runtime wasm assets including the ortWasmPath option.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[README.md before] -->|Removed| B["> Developer preview warning"]
    A -->|Removed| C["> Browser/Node.js storage model note"]
    A -->|Removed| D["> ONNX Runtime CDN / ortWasmPath guidance"]
    A -->|Kept| E[Badges, See It In Action, rest of README]
    B & C & D -.->|deleted in this PR| X[No longer in README]
Loading

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

Comment thread README.md
@@ -19,16 +19,6 @@
<img src="https://img.shields.io/badge/Web-Browser%20%7C%20Node.js-3178C6" alt="Browser and Node.js">
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Developer-preview disclaimer removed — confirm API is stable

The removed blockquote stated "Developer preview. APIs may change between releases." If the library is still in an early/unstable phase, dropping this notice could lead consumers to assume API stability they should not assume, leading to surprise breaking changes between releases. Please confirm the API has stabilised before removing this warning, or replace it with a versioned stability guarantee (e.g. SemVer commitment).

Comment thread README.md
@@ -19,16 +19,6 @@
<img src="https://img.shields.io/badge/Web-Browser%20%7C%20Node.js-3178C6" alt="Browser and Node.js">
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Production CDN/self-hosting guidance removed

The deleted note explained that ONNX Runtime wasm assets are loaded from a CDN by default and that ortWasmPath can be set to self-host them for supply-chain or offline scenarios. This is actionable information for production users — without it, there is no hint in the docs that CDN loading happens or that it can be overridden. Consider moving this content to a dedicated "Configuration" or "Production" section rather than dropping it entirely.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

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.

1 participant