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

Add act documentation #6901

Merged
merged 3 commits into from
May 28, 2024
Merged

Add act documentation #6901

merged 3 commits into from
May 28, 2024

Conversation

jackpope
Copy link
Collaborator

@jackpope jackpope requested a review from rickhanlonii May 22, 2024 15:58
Copy link

vercel bot commented May 22, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
19-react-dev ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 24, 2024 4:20pm
react-dev ✅ Ready (Inspect) Visit Preview May 24, 2024 4:20pm

@rickhanlonii
Copy link
Member

Can you update this to match our other Reference pages?

The top section should be a one-line short description, followed by a psudoish code example, and a TOC:

Screenshot 2024-05-22 at 2 54 07 PM

Then a Reference with a short example, parameters, returns, and caveats

Screenshot 2024-05-22 at 2 55 29 PM

Then a usage section with headings that explain the use case and are visible in the right sidebar:

Screenshot 2024-05-22 at 2 56 10 PM

Then a troubleshooting section:

Screenshot 2024-05-22 at 2 56 55 PM

We can defer the troubleshooting section, but it would include things like not using await or not setting the IS_ACT_ENV global.

@rickhanlonii
Copy link
Member

And can we change the base branch to main? Since this was added to 18.3, it should be added to those docs. I'll merge it into the v19 branch

@jackpope jackpope changed the base branch from v19 to main May 24, 2024 08:31
Copy link

github-actions bot commented May 24, 2024

Size changes

📦 Next.js Bundle Analysis for react-dev

This analysis was generated by the Next.js Bundle Analysis action. 🤖

One Page Changed Size

The following page changed size from the code in this PR compared to its base branch:

Page Size (compressed) First Load
/[[...markdownPath]] 82.63 KB (🟡 +6 B) 186.78 KB
Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

Next to the size is how much the size has increased or decreased compared with the base branch of this PR. If this percentage has increased by 10% or more, there will be a red status indicator applied, indicating that special attention should be given to this.

@jackpope jackpope merged commit 12fca4c into reactjs:main May 28, 2024
6 checks passed
@jackpope jackpope deleted the v19-act branch May 28, 2024 19:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants