Skip to content

DOCS Improve the Getting Started section of the readme#5534

Merged
hoodmane merged 2 commits intopyodide:mainfrom
hoodmane:getting-started-improvement
Mar 24, 2025
Merged

DOCS Improve the Getting Started section of the readme#5534
hoodmane merged 2 commits intopyodide:mainfrom
hoodmane:getting-started-improvement

Conversation

@hoodmane
Copy link
Member

We didn't suggest anything for package maintainers, for people who want to use bundlers, or for people who want to use it in node. This provides some more suggestions for first links for people to look at depending on their needs.

We didn't suggest anything for package maintainers, for people who want
to use bundlers, or for people who want to use it in node. This provides
some more suggestions for first links for people to look at depending on
their needs.
- `cdn.jsdelivr.net/npm/pyodide@0.19.0/` is a mirror of the Pyodide NPM package, which includes none of the WASM files
- `cdn.jsdelivr.net/pyodide/` distributes Python packages built with Pyodide as well
as `pyodide.js`
- `cdn.jsdelivr.net/npm/pyodide@0.19.0/` is a mirror of the Pyodide NPM package which
Copy link
Member Author

Choose a reason for hiding this comment

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

Maybe we should make the version here update with the current Pyodide version too.

Copy link
Member Author

Choose a reason for hiding this comment

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

which includes none of the WASM files

Should have always been "includes none of the wheel files".

Copy link
Member

Choose a reason for hiding this comment

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

Maybe we should make the version here update with the current Pyodide version too.

sounds good to me.

Comment on lines -76 to -80
```{note}
The following instructions have been tested with Node.js 18.5.0. To use
Pyodide with older versions of Node, you might need to use additional command line
arguments, see below.
```
Copy link
Member Author

Choose a reason for hiding this comment

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

I think this note is superseded by the note above it saying that older versions aren't supported.

Copy link
Member

@ryanking13 ryanking13 left a comment

Choose a reason for hiding this comment

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

Thanks!

- `cdn.jsdelivr.net/npm/pyodide@0.19.0/` is a mirror of the Pyodide NPM package, which includes none of the WASM files
- `cdn.jsdelivr.net/pyodide/` distributes Python packages built with Pyodide as well
as `pyodide.js`
- `cdn.jsdelivr.net/npm/pyodide@0.19.0/` is a mirror of the Pyodide NPM package which
Copy link
Member

Choose a reason for hiding this comment

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

Maybe we should make the version here update with the current Pyodide version too.

sounds good to me.

@hoodmane hoodmane merged commit 8ae613d into pyodide:main Mar 24, 2025
38 of 40 checks passed
@hoodmane hoodmane deleted the getting-started-improvement branch March 24, 2025 10:02
@agriyakhetarpal agriyakhetarpal changed the title DOCS Improve the Getting Stated section of the readme DOCS Improve the Getting Started section of the readme Mar 25, 2025
hoodmane added a commit to hoodmane/pyodide that referenced this pull request Mar 26, 2025
We didn't suggest anything for package maintainers, for people who want to use bundlers,
or for people who want to use it in node. This provides some more suggestions for first links
for people to look at depending on their needs.
hoodmane added a commit to hoodmane/pyodide that referenced this pull request Apr 3, 2025
We didn't suggest anything for package maintainers, for people who want to use bundlers,
or for people who want to use it in node. This provides some more suggestions for first links
for people to look at depending on their needs.
hoodmane added a commit to hoodmane/pyodide that referenced this pull request Apr 3, 2025
We didn't suggest anything for package maintainers, for people who want to use bundlers,
or for people who want to use it in node. This provides some more suggestions for first links
for people to look at depending on their needs.
hoodmane added a commit to hoodmane/pyodide that referenced this pull request Apr 3, 2025
We didn't suggest anything for package maintainers, for people who want to use bundlers,
or for people who want to use it in node. This provides some more suggestions for first links
for people to look at depending on their needs.
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.

2 participants