improve docs and strucutre

Author: mattcosta7

.github/workflows/ci.yml

@@ -21,6 +21,7 @@ jobs:
           node-version: 22
           cache: npm
       - run: npm ci
+      - run: npm run build
       - run: npm run lint
 
   typecheck:
@@ -33,6 +34,7 @@ jobs:
           node-version: 22
           cache: npm
       - run: npm ci
+      - run: npm run build
       - run: npm run tsc
 
   test:

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at <opensource@github.com>. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,62 @@
+## Contributing
+
+[fork]: https://github.com/github/storybook-addon-performance-panel/fork
+[pr]: https://github.com/github/storybook-addon-performance-panel/compare
+
+Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
+
+Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE).
+
+Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
+
+## Project structure
+
+This is an npm workspaces monorepo with two packages:
+
+| Directory | Package | Description |
+|-----------|---------|-------------|
+| `packages/storybook-addon-performance-panel` | `@github-ui/storybook-addon-performance-panel` | The addon — collectors, panel UI, and types |
+| `packages/docs` | `@github-ui/docs` | Documentation site built with Storybook |
+
+### Useful commands
+
+| Command | Description |
+|---------|-------------|
+| `npm run build` | Build the addon |
+| `npm run build:watch` | Build the addon in watch mode |
+| `npm test` | Run tests |
+| `npm run lint` | Lint with ESLint + Prettier |
+| `npm run tsc` | Type-check the addon |
+| `npm run docs` | Build the addon and start the docs site locally |
+| `npm run docs:build` | Build the addon and the docs site for production |
+
+## Prerequisites for running and testing code
+
+These are one time installations required to be able to test your changes locally as part of the pull request (PR) submission process.
+
+1. Install [Node.js](https://nodejs.org/) (v22 or later)
+1. Install dependencies: `npm install`
+
+## Submitting a pull request
+
+1. [Fork][fork] and clone the repository
+1. Install the dependencies: `npm install`
+1. Build the addon: `npm run build`
+1. Make sure the tests pass on your machine: `npm test`
+1. Make sure the linter passes: `npm run lint`
+1. Create a new branch: `git checkout -b my-branch-name`
+1. Make your change, add tests, and make sure the tests and linter still pass
+1. Push to your fork and [submit a pull request][pr]
+1. Pat yourself on the back and wait for your pull request to be reviewed and merged.
+
+Here are a few things you can do that will increase the likelihood of your pull request being accepted:
+
+- Write tests.
+- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
+- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+
+## Resources
+
+- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
+- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
+- [GitHub Help](https://help.github.com)

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright GitHub, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

SECURITY.md

@@ -0,0 +1,31 @@
+Thanks for helping make GitHub safe for everyone.
+
+# Security
+
+GitHub takes the security of our software products and services seriously, including all of the open source code repositories managed through our GitHub organizations, such as [GitHub](https://github.com/GitHub).
+
+Even though [open source repositories are outside of the scope of our bug bounty program](https://bounty.github.com/index.html#scope) and therefore not eligible for bounty rewards, we will ensure that your finding gets passed along to the appropriate maintainers for remediation. 
+
+## Reporting Security Issues
+
+If you believe you have found a security vulnerability in any GitHub-owned repository, please report it to us through coordinated disclosure.
+
+**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.**
+
+Instead, please send an email to opensource-security[@]github.com.
+
+Please include as much of the information listed below as you can to help us better understand and resolve the issue:
+
+  * The type of issue (e.g., buffer overflow, SQL injection, or cross-site scripting)
+  * Full paths of source file(s) related to the manifestation of the issue
+  * The location of the affected source code (tag/branch/commit or direct URL)
+  * Any special configuration required to reproduce the issue
+  * Step-by-step instructions to reproduce the issue
+  * Proof-of-concept or exploit code (if possible)
+  * Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+## Policy
+
+See [GitHub's Safe Harbor Policy](https://docs.github.com/en/site-policy/security-policies/github-bug-bounty-program-legal-safe-harbor#1-safe-harbor-terms)

SUPPORT.md

@@ -0,0 +1,13 @@
+# Support
+
+## How to file issues and get help
+
+This project uses GitHub issues to track bugs and feature requests. Please search the [existing issues](https://github.com/github/storybook-addon-performance-panel/issues) before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new issue.
+
+For help or questions about using this project, please open a [GitHub Discussion](https://github.com/github/storybook-addon-performance-panel/discussions) or file an issue.
+
+**storybook-addon-performance-panel** is under active development and maintained by GitHub staff. We will do our best to respond to support, feature requests, and community questions in a timely manner.
+
+## GitHub Support Policy
+
+Support for this project is limited to the resources listed above.

package.json

@@ -6,13 +6,13 @@
     "packages/*"
   ],
   "scripts": {
-    "build": "npm run build -w packages/storybook-addon-performance-panel",
-    "build:watch": "npm run build:watch -w packages/storybook-addon-performance-panel",
+    "build": "npm run build -w @github-ui/storybook-addon-performance-panel",
+    "build:watch": "npm run build:watch -w @github-ui/storybook-addon-performance-panel",
     "lint": "eslint . --cache",
-    "test": "npm test -w packages/storybook-addon-performance-panel",
+    "test": "npm test -w @github-ui/storybook-addon-performance-panel",
     "tsc": "tsc -b packages/storybook-addon-performance-panel/tsconfig.build.json",
-    "docs": "npm run build && npm run storybook -w packages/docs",
-    "docs:build": "npm run build && npm run build-storybook -w packages/docs"
+    "docs": "npm run build && npm run storybook -w @github-ui/docs",
+    "docs:build": "npm run build && npm run build-storybook -w @github-ui/docs"
   },
   "devDependencies": {
     "@eslint/js": "^9.0.1",

packages/docs/stories/Metrics.mdx

@@ -62,6 +62,7 @@ Collected via `requestAnimationFrame` loop (heuristic).
 </table>
 
 
+
 **How it works:** A `requestAnimationFrame` callback measures the delta between frames. Each delta is compared against the 16.67ms target (60fps). Dropped frames are those where `delta > 33.34ms`. Frame stability tracks how consistently frames hit the target timing.
 
 ---
@@ -120,6 +121,7 @@ Collected via [Event Timing API](https://w3c.github.io/event-timing/) (optimal,
 </table>
 
 
+
 **Interaction breakdown:** Each interaction timing is shown as `[wait Xms] → [js Xms] → [paint Xms]`:
 - **Wait** = input delay (main thread was busy before handlers ran)
 - **JS** = processing time (event handler execution)
@@ -171,6 +173,7 @@ Collected via [Long Tasks API](https://w3c.github.io/longtasks/) (optimal, Chrom
 </table>
 
 
+
 **How TBT works:** For each long task, only the time exceeding 50ms counts. A 70ms task contributes 20ms to TBT. This matches the [Lighthouse TBT methodology](https://web.dev/articles/tbt).
 
 ---
@@ -211,6 +214,7 @@ Collected via [Long Animation Frames API](https://w3c.github.io/long-animation-f
 </table>
 
 
+
 **Why LoAF matters:** Unlike Long Tasks, LoAF provides **script attribution** — which functions in which files caused the slow frame. Invoker types include `event-listener`, `user-callback`, `resolve-promise`, and `classic-script`. This is the primary tool for debugging INP issues.
 
 ---
@@ -248,6 +252,7 @@ Collected via [Layout Instability API](https://w3c.github.io/layout-instability/
 </table>
 
 
+
 **Session windowing:** CLS uses session windows per the Core Web Vitals spec: groups of shifts with &lt;1s gaps and &lt;5s total duration. The final CLS is the maximum session window value.
 
 ---
@@ -276,6 +281,7 @@ Collected via [Layout Instability API](https://w3c.github.io/layout-instability/
 </table>
 
 
+
 **Forced Reflows** — collected via property getter instrumentation (heuristic).
 
 <table>
@@ -298,6 +304,7 @@ Collected via [Layout Instability API](https://w3c.github.io/layout-instability/
 </table>
 
 
+
 **What triggers a forced reflow:** Reading any layout property (`offsetHeight`, `getBoundingClientRect()`, `getComputedStyle()`, etc.) after writing styles forces the browser to synchronously recalculate layout. This is one of the most common causes of jank.
 
 ---
@@ -342,6 +349,7 @@ Collected via [React Profiler API](https://react.dev/reference/react/Profiler) (
 </table>
 
 
+
 **Render cascades** indicate `setState` called during the commit phase, typically in `useLayoutEffect`. These trigger synchronous re-renders and are expensive. Even 1 render cascade per interaction is worth investigating.
 
 **Profiling in production:** By default, React strips the Profiler API in production builds. To keep it working in deployed Storybook, alias `react-dom/client` to `react-dom/profiling` in your Vite config (see [Setup Guide](?path=/docs/guides-setup--docs#react-profiling-in-production-builds)).
@@ -376,6 +384,7 @@ Collected via [React Profiler API](https://react.dev/reference/react/Profiler) (
 </table>
 
 
+
 **GC Pressure:** Sustained values &gt;1 MB/s indicate memory-intensive operations. High GC pressure causes periodic frame drops when the garbage collector runs.
 
 **Paint & Resources** — collected via Paint Timing API and Resource Timing API (optimal, all browsers).
@@ -404,6 +413,7 @@ Collected via [React Profiler API](https://react.dev/reference/react/Profiler) (
 </table>
 
 
+
 ---
 
 ## Element Timing
@@ -434,6 +444,7 @@ Collected via [Element Timing API](https://w3c.github.io/element-timing/) (optim
 </table>
 
 
+
 **Usage:** Add the `elementtiming` attribute to any element you want to track:
 
 ```tsx
@@ -525,4 +536,5 @@ Collected via [Element Timing API](https://w3c.github.io/element-timing/) (optim
 </table>
 
 
+
 **Chrome/Edge is recommended** for the most complete metrics during development and debugging.