docs: add build and installation instructions to README#1
docs: add build and installation instructions to README#1felipereisdev wants to merge 1 commit intobeyondcode:mainfrom
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ee1d4277e9
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| ```bash | ||
| cd packages/chrome-extension | ||
| npm install | ||
| npm run build |
There was a problem hiding this comment.
Build the extension against the checked-out SDK sources
These commands install @polyscope/sdk from npm, not from this checkout: packages/chrome-extension/package-lock.json:800-802 pins the dependency to the published sdk-0.1.0.tgz, and packages/chrome-extension/src/background/index.ts:8 imports that package directly. In practice, someone following this new “Building from Source” section will get a bundle that ignores any local edits under src/sdk/, so it is easy to validate the wrong code after making source changes in this repo.
Useful? React with 👍 / 👎.
| 3. Click **Load unpacked** | ||
| 4. Select the `packages/chrome-extension/dist/` folder | ||
|
|
||
| The extension icon will appear in your Chrome toolbar. Click it to toggle in-page tools on or off. You can also activate the element picker with the keyboard shortcut `Alt+Shift+P`. |
There was a problem hiding this comment.
Document how users actually open the Polyscope panel
The install section currently stops at loading the unpacked extension and then says to click the toolbar icon, but the code does not expose the panel that way: packages/chrome-extension/public/manifest.json:13-21 has no default_popup, and packages/chrome-extension/src/background/index.ts:851-865 uses left-click to toggle in-page tools while the actual panel is only available from the action context menu. For a first-time user, following these steps leaves no documented path to sign in or choose a workspace, so the extension appears unusable after installation.
Useful? React with 👍 / 👎.
Summary
build,dev,typecheck,package)Alt+Shift+Pshortcut