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

Profiler API docs #2176

Merged
merged 4 commits into from Aug 8, 2019
Merged

Profiler API docs #2176

merged 4 commits into from Aug 8, 2019

Conversation

bvaughn
Copy link
Contributor

@bvaughn bvaughn commented Jul 27, 2019

Includes a 16.9 release notes section with an arbitrary/random date mentioning the new Profiler API and a reference page with examples and docs.

Open Questions

  • I didn't go into as much depth as I could (or as I did in the RFC for example) because I feel like the profiling story is currently incomplete until I've been able to tackle the root events API. Are these docs okay for now or are they too shallow?
  • I just linked to the fb.me URL for interactions, since that API is currently unstable.
  • I linked to fb.me/react-profiling for instructions on enabling the production+profiling bundle. Should I inline these instructions into the reference docs somewhere instead?

@reactjs-bot
Copy link

reactjs-bot commented Jul 27, 2019

Deploy preview for reactjs ready!

Built with commit ab6a07a

https://deploy-preview-2176--reactjs.netlify.com

facebook-github-bot pushed a commit to facebook/flow that referenced this pull request Jul 30, 2019
Summary:
* Profiler RFC: https://github.com/reactjs/rfcs/blob/master/text/0051-profiler.md
* Profiler release documentation: reactjs/react.dev#2176

cc jbrown215
Pull Request resolved: #7979

Reviewed By: bvaughn

Differential Revision: D16562521

Pulled By: jbrown215

fbshipit-source-id: 7afee058cfe159a30807d2c7f60966942dbac504
@gaearon gaearon mentioned this pull request Aug 8, 2019
9 tasks
@@ -86,7 +86,8 @@
"nit:examples": "prettier --config examples/.prettierrc --list-different \"examples/**/*.js\"",
"prettier": "yarn format:source && yarn format:examples",
"prettier:diff": "yarn nit:source && yarn nit:examples",
"reset": "rimraf ./.cache"
"reset": "rimraf ./.cache",
"start": "yarn dev"
Copy link
Member

Choose a reason for hiding this comment

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

lol

Copy link
Contributor Author

Choose a reason for hiding this comment

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

lol you caught me 😉 this always trips me up

Copy link
Member

Choose a reason for hiding this comment

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

Sme

@bvaughn bvaughn merged commit 129df30 into reactjs:master Aug 8, 2019
@bvaughn bvaughn deleted the profiler-docs branch August 8, 2019 21:18
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.

None yet

4 participants