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

Node and pnpm related updates and cleanup #11808

Merged
merged 3 commits into from
Mar 12, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ on:
permissions: read-all

env:
NODE_VERSION: 20
NODE_VERSION: 22

jobs:
test:
Expand Down
48 changes: 24 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[Flutter logo]: https://github.com/dart-lang/site-shared/blob/main/src/_assets/image/flutter/icon/64.png?raw=1

# [Flutter][] documentation website
# [Flutter][] documentation website

The [documentation site][Flutter] for the [Flutter framework][],
built with [Eleventy][] and hosted on [Firebase][].
Expand Down Expand Up @@ -32,41 +32,41 @@ built with [Eleventy][] and hosted on [Firebase][].

## Issues, bugs, and requests

We welcome contributions and feedback on our website.
We welcome contributions and feedback on our website.
Please file a request in our
[issue tracker](https://github.com/flutter/website/issues/new/choose)
or create a [pull request](https://github.com/flutter/website/pulls).
For simple changes (such as tweaking some text),
[issue tracker](https://github.com/flutter/website/issues/new/choose)
or create a [pull request](https://github.com/flutter/website/pulls).
For simple changes (such as tweaking some text),
it's easiest to make changes using the GitHub UI.

If you have an issue with the
API docs on [api.flutter.dev](https://api.flutter.dev),
please file those issues on
the [`flutter/flutter`](https://github.com/flutter/flutter/issues) repo,
not on this (`flutter/website`) repo.
The API docs are embedded in Flutter's source code,
If you have an issue with the
API docs on [api.flutter.dev](https://api.flutter.dev),
please file those issues on
the [`flutter/flutter`](https://github.com/flutter/flutter/issues) repo,
not on this (`flutter/website`) repo.
The API docs are embedded in Flutter's source code,
so the engineering team handles those.


## Before you submit a PR

We love it when the community gets involved in improving our docs!
We love it when the community gets involved in improving our docs!
But here are a few notes to keep in mind before you submit a PR:

- When triaging issues,
we sometimes label an issue with the tag **PRs welcome**.
- When triaging issues,
we sometimes label an issue with the tag **PRs welcome**.
But we welcome PRs on other issues as well—
it doesn't have to be tagged with that label.
- Please don't run our docs through Grammarly (or similar)
- Please don't run our docs through Grammarly (or similar)
and submit those changes as a PR.
- We follow the [Google Developer Documentation Style Guidelines][] —
for example, don't use "i.e." or "e.g.",
for example, don't use "i.e." or "e.g.",
avoid writing in first person,
and avoid writing in future tense.
You can start with the
[style guide highlights](https://developers.google.com/style/highlights)
or the [word list](https://developers.google.com/style/word-list),
or use the search bar that's at the top of every style guide page.
[style guide highlights](https://developers.google.com/style/highlights)
or the [word list](https://developers.google.com/style/word-list),
or use the search bar at the top of every style guide page.

> We truly thank you for your willingness and helpfulness
> in keeping the website docs up to date!
Expand All @@ -83,12 +83,12 @@ you probably don't need to build this site.
Often you can make changes using the GitHub UI.
If needed, we can stage the changes automatically in your pull request.

> [!IMPORTANT]
> [!IMPORTANT]
> If you are cloning this repository locally,
> follow the below instruction on cloning with its submodule.

If your change involves code samples, adds/removes pages, or affects navigation,
do consider building and test your work before submitting.
do consider building and testing your work before submitting.

If you want or need to build the site, follow the steps below.

Expand Down Expand Up @@ -239,7 +239,7 @@ following the instructions in [Get the prerequisites](#get-the-prerequisites).
```console
pnpm install
```

Rerun `pnpm install` whenever you incorporate the
latest changes to the `main` branch or if you
experience dependency or import errors when building the site.
Expand Down Expand Up @@ -318,7 +318,7 @@ in the corresponding `.dart` files.

The `.dart` files are the source of truth for code snippets,
and the preceding `<?code-excerpt>` instructions in Markdown files specify
how the snippets are copied from the `.dart` files.
how the snippets are copied from the `.dart` files.

To resolve this error and update the Markdown snippets to match,
from the root of the `website` directory,
Expand All @@ -341,7 +341,7 @@ you can build a full version and upload it to Firebase.
- Navigate to the [Firebase Console](https://console.firebase.google.com)
and create your own Firebase project (for example, `flutter-dev-staging`).

- Head back to your local terminal and verify that you are logged in.
- Head back to your local terminal and verify that you're logged in.

```console
firebase login
Expand Down
2 changes: 1 addition & 1 deletion dash_site
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/bash

REQUIRED_DART_VERSION="3.6"
REQUIRED_DART_VERSION="3.7"
REQUIRED_NODE_VERSION="22.11"
REQUIRED_PNPM_VERSION="9.12"

Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"node": ">=22.11.0",
"pnpm": ">=9.12.3"
},
"packageManager": "pnpm@10.5.0",
"packageManager": "pnpm@10.6.2",
"scripts": {
"serve": "PRODUCTION=false tsx node_modules/@11ty/eleventy/cmd.cjs --serve --config=eleventy.config.ts",
"build-site-for-staging": "PRODUCTION=false OPTIMIZE=true tsx node_modules/@11ty/eleventy/cmd.cjs --config=eleventy.config.ts",
Expand All @@ -22,8 +22,8 @@
"@11ty/eleventy": "^3.0.0",
"@types/hast": "^3.0.4",
"@types/markdown-it": "^14.1.2",
"@types/node": "^22.13.5",
"firebase-tools": "^13.31.2",
"@types/node": "^22.13.10",
"firebase-tools": "^13.34.0",
"hast-util-from-html": "^2.0.3",
"hast-util-select": "^6.0.4",
"hast-util-to-html": "^9.0.5",
Expand All @@ -37,7 +37,7 @@
"markdown-it-deflist": "^3.0.0",
"markdown-it-footnote": "^4.0.0",
"sass": "^1.85.1",
"shiki": "^2.5.0",
"shiki": "^3.2.1",
"tsx": "^4.19.3"
},
"pnpm": {
Expand Down
Loading
Loading